imagebuilder / Client / get_lifecycle_execution

get_lifecycle_execution¶

imagebuilder.Client.get_lifecycle_execution(**kwargs)¶

Retrieves runtime information for a lifecycle execution – a single run of lifecycle actions that a lifecycle policy or a StartResourceStateUpdate request started.

Request Syntax

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

Parameters:

lifecycleExecutionId (string) –

[REQUIRED]

The unique identifier for a runtime instance of the lifecycle policy.

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) –
    
    A summary flag that indicates whether the lifecycle execution identified any resources to take lifecycle actions on.
    - hasImpactedResources (boolean) –
      
      Indicates whether the lifecycle execution identified any resources to take lifecycle actions on.
  - state (dict) –
    
    Runtime state that reports whether the lifecycle execution is in progress, succeeded, or failed.
    - 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

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException