imagebuilder / Client / get_lifecycle_execution

get_lifecycle_execution#

imagebuilder.Client.get_lifecycle_execution(**kwargs)#

Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.

See also: AWS API Documentation

Request Syntax

response = client.get_lifecycle_execution(
    lifecycleExecutionId='string'
)
Parameters:

lifecycleExecutionId (string) –

[REQUIRED]

Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

Return type:

dict

Returns:

Response Syntax

{
    'lifecycleExecution': {
        'lifecycleExecutionId': 'string',
        'lifecyclePolicyArn': 'string',
        'resourcesImpactedSummary': {
            'hasImpactedResources': True|False
        },
        'state': {
            'status': 'IN_PROGRESS'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS'|'PENDING',
            'reason': 'string'
        },
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • lifecycleExecution (dict) –

      Runtime details for the specified runtime instance of the lifecycle policy.

      • lifecycleExecutionId (string) –

        Identifies the lifecycle policy runtime instance.

      • lifecyclePolicyArn (string) –

        The Amazon Resource Name (ARN) of the lifecycle policy that ran.

      • resourcesImpactedSummary (dict) –

        Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy.

        • hasImpactedResources (boolean) –

          Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.

      • state (dict) –

        Runtime state that reports if the policy action ran successfully, failed, or was skipped.

        • status (string) –

          The runtime status of the lifecycle execution.

        • reason (string) –

          The reason for the current status.

      • startTime (datetime) –

        The timestamp when the lifecycle runtime instance started.

      • endTime (datetime) –

        The timestamp when the lifecycle runtime instance completed.

Exceptions