imagebuilder / Client / get_lifecycle_policy

get_lifecycle_policy¶

imagebuilder.Client.get_lifecycle_policy(**kwargs)¶

Retrieves details for the specified image lifecycle policy.

Request Syntax

response = client.get_lifecycle_policy(
    lifecyclePolicyArn='string'
)

Parameters:

lifecyclePolicyArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

Return type:

dict

Returns:

Response Syntax

{
    'lifecyclePolicy': {
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'status': 'DISABLED'|'ENABLED',
        'executionRole': 'string',
        'resourceType': 'AMI_IMAGE'|'CONTAINER_IMAGE',
        'policyDetails': [
            {
                'action': {
                    'type': 'DELETE'|'DEPRECATE'|'DISABLE',
                    'includeResources': {
                        'amis': True|False,
                        'snapshots': True|False,
                        'containers': True|False
                    }
                },
                'filter': {
                    'type': 'AGE'|'COUNT',
                    'value': 123,
                    'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS',
                    'retainAtLeast': 123
                },
                'exclusionRules': {
                    'tagMap': {
                        'string': 'string'
                    },
                    'amis': {
                        'isPublic': True|False,
                        'regions': [
                            'string',
                        ],
                        'sharedAccounts': [
                            'string',
                        ],
                        'lastLaunched': {
                            'value': 123,
                            'unit': 'DAYS'|'WEEKS'|'MONTHS'|'YEARS'
                        },
                        'tagMap': {
                            'string': 'string'
                        }
                    }
                }
            },
        ],
        'resourceSelection': {
            'recipes': [
                {
                    'name': 'string',
                    'semanticVersion': 'string'
                },
            ],
            'tagMap': {
                'string': 'string'
            }
        },
        'dateCreated': datetime(2015, 1, 1),
        'dateUpdated': datetime(2015, 1, 1),
        'dateLastRun': datetime(2015, 1, 1),
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) –
- lifecyclePolicy (dict) –
  
  The details of the lifecycle policy that the request retrieved.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the lifecycle policy resource.
  - name (string) –
    
    The name of the lifecycle policy.
  - description (string) –
    
    Optional description for the lifecycle policy.
  - status (string) –
    
    Indicates whether the lifecycle policy resource is enabled. Only enabled policies run on their schedule. Disabling or deleting a policy removes its schedule and cancels any in-flight lifecycle execution.
  - executionRole (string) –
    
    The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.
  - resourceType (string) –
    
    The type of resources the lifecycle policy targets.
  - policyDetails (list) –
    
    The list of rules for the lifecycle policy. Each rule pairs an action with a filter and optional exclusion rules. A policy can contain at most one rule per action type.
    - (dict) –
      
      Defines one lifecycle policy rule: the action to take, the filter that determines which resources the rule applies to, and optional exclusion rules.
      - action (dict) –
        
        Configuration details for the policy action.
        
        type (string) –
        
        Specifies the lifecycle action to take. DELETE deletes the image resource and, with includeResources, also removes distributed AMIs, snapshots, or container images. DEPRECATE and DISABLE set the corresponding status on the image resource and, if includeResources.amis is set, on its distributed AMIs.
        
        includeResources (dict) –
        
        Specifies which underlying resources the action extends to beyond the Image Builder image resource itself: distributed AMIs, their snapshots, or distributed container images. DELETE rules can include all three, DEPRECATE and DISABLE rules can include AMIs only, and you can only include snapshots together with AMIs.
        
        amis (boolean) –
        
        Specifies whether the lifecycle action should apply to distributed AMIs.
        
        snapshots (boolean) –
        
        Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.
        
        containers (boolean) –
        
        Specifies whether the lifecycle action should apply to distributed containers.
      - filter (dict) –
        
        Specifies the resources that the lifecycle policy applies to.
        
        type (string) –
        
        Filter resources based on either AGE or COUNT. You can only use the count filter with the DELETE action type.
        
        value (integer) –
        
        The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.
        
        Note
        For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
        
        unit (string) –
        
        Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.
        
        retainAtLeast (integer) –
        
        For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.
      - exclusionRules (dict) –
        
        Additional rules to specify resources that should be exempt from policy actions.
        
        tagMap (dict) –
        
        Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.
        
        (string) –
        
        (string) –
        
        amis (dict) –
        
        Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.
        
        isPublic (boolean) –
        
        Configures whether public AMIs are excluded from the lifecycle action.
        
        regions (list) –
        
        Configures Amazon Web Services Regions that are excluded from the lifecycle action.
        
        (string) –
        
        sharedAccounts (list) –
        
        The lifecycle action doesn’t apply to AMIs that are shared with any of the specified Amazon Web Services accounts.
        
        (string) –
        
        lastLaunched (dict) –
        
        Configures Image Builder to exclude AMIs that were launched within the specified time period from lifecycle actions. AMIs with no recorded last-launched time aren’t excluded by this rule.
        
        value (integer) –
        
        The integer number of units for the time period. For example 6 (months).
        
        unit (string) –
        
        Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last launch.
        
        tagMap (dict) –
        
        Lifecycle actions don’t apply to AMIs that have any of these tags. Both the key and the value must match.
        
        (string) –
        
        (string) –
  - resourceSelection (dict) –
    
    Resource selection criteria used to run the lifecycle policy.
    - recipes (list) –
      
      A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.
      - (dict) –
        
        Specifies an Image Builder recipe that the lifecycle policy uses for resource selection.
        
        name (string) –
        
        The name of an Image Builder recipe that the lifecycle policy uses for resource selection.
        
        semanticVersion (string) –
        
        The version of the Image Builder recipe specified by the name field.
    - tagMap (dict) –
      
      A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.
      - (string) –
        
        (string) –
  - 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) –

get_lifecycle_policy¶

Request Syntax

Response Syntax

Response Structure

Note

Exceptions