imagebuilder / Client / list_lifecycle_executions

list_lifecycle_executions¶

imagebuilder.Client.list_lifecycle_executions(**kwargs)¶

Retrieves the lifecycle runtime history for the specified resource.

Request Syntax

response = client.list_lifecycle_executions(
    maxResults=123,
    nextToken='string',
    resourceArn='string'
)

Parameters:

maxResults (integer) – The maximum number of items to return in a single request.
nextToken (string) – A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
resourceArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which to list lifecycle executions. Specify a lifecycle policy ARN to list its executions, or an image build version ARN to list the executions that StartResourceStateUpdate started for that image. Other ARN types aren’t valid for this request.

Return type:

dict

Returns:

Response Syntax

{
    'lifecycleExecutions': [
        {
            '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)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- lifecycleExecutions (list) –
  
  A list of lifecycle runtime instances for the specified resource.
  - (dict) –
    
    Contains metadata from a runtime instance of a 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.
- nextToken (string) –
  
  The next token used for paginated responses. When this field isn’t empty, there are additional elements that the service hasn’t included in this request. Use this token with the next request to retrieve additional objects.

Exceptions

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