imagebuilder / Paginator / ListLifecyclePolicies

ListLifecyclePolicies¶

class imagebuilder.Paginator.ListLifecyclePolicies¶

paginator = client.get_paginator('list_lifecycle_policies')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from imagebuilder.Client.list_lifecycle_policies().

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

filters (list) –
Streamline results based on one of the following values: Name, Status.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  - name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - values (list) –
    
    The filter values. Filter values are case-sensitive.
    - (string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'lifecyclePolicySummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'DISABLED'|'ENABLED',
            'executionRole': 'string',
            'resourceType': 'AMI_IMAGE'|'CONTAINER_IMAGE',
            'dateCreated': datetime(2015, 1, 1),
            'dateUpdated': datetime(2015, 1, 1),
            'dateLastRun': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- lifecyclePolicySummaryList (list) –
  
  A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.
  - (dict) –
    
    Contains a summary of lifecycle policy resources.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the lifecycle policy summary resource.
    - name (string) –
      
      The name of the lifecycle policy.
    - description (string) –
      
      Optional description for the lifecycle policy.
    - status (string) –
      
      The lifecycle policy resource status.
    - executionRole (string) –
      
      The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.
    - resourceType (string) –
      
      The type of resources the lifecycle policy targets.
    - dateCreated (datetime) –
      
      The timestamp when Image Builder created the lifecycle policy resource.
    - dateUpdated (datetime) –
      
      The timestamp when Image Builder updated the lifecycle policy resource.
    - dateLastRun (datetime) –
      
      The timestamp for the last time Image Builder ran the lifecycle policy.
    - tags (dict) –
      
      To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  A token to resume pagination.