imagebuilder / Paginator / ListContainerRecipes

ListContainerRecipes¶

class imagebuilder.Paginator.ListContainerRecipes¶

paginator = client.get_paginator('list_container_recipes')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty'|'AWSMarketplace',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

owner (string) – Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account. For container recipes, the valid owner values are Self, Shared, and Amazon.
filters (list) –
Use the following filters to streamline results:
- containerType
- name
- parentImage
- platform
- (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

{
    'requestId': 'string',
    'containerRecipeSummaryList': [
        {
            'arn': 'string',
            'containerType': 'DOCKER',
            'name': 'string',
            'platform': 'Windows'|'Linux'|'macOS',
            'owner': 'string',
            'parentImage': 'string',
            'dateCreated': 'string',
            'instanceImage': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- containerRecipeSummaryList (list) –
  
  The list of container recipes returned for the request.
  - (dict) –
    
    A summary of a container recipe.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the container recipe.
    - containerType (string) –
      
      Specifies the type of container, such as “Docker”.
    - name (string) –
      
      The name of the container recipe.
    - platform (string) –
      
      The system platform for the container. Container recipes support only the Linux and Windows platforms.
    - owner (string) –
      
      The owner of the container recipe.
    - parentImage (string) –
      
      The base image for the container recipe.
    - dateCreated (string) –
      
      The date when this container recipe was created.
    - instanceImage (string) –
      
      The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.
      
      If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.
    - tags (dict) –
      
      Tags that are attached to the container recipe.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  A token to resume pagination.