imagebuilder / Client / list_container_recipes

list_container_recipes#

imagebuilder.Client.list_container_recipes(**kwargs)#

Returns a list of container recipes.

Request Syntax

response = client.list_container_recipes(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='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.
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) –
maxResults (integer) – The maximum number of results to return in the list.
nextToken (string) – Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'containerRecipeSummaryList': [
        {
            'arn': 'string',
            'containerType': 'DOCKER',
            'name': 'string',
            'platform': 'Windows'|'Linux',
            'owner': 'string',
            'parentImage': 'string',
            'dateCreated': '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, such as Windows or Linux.
    - 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.
    - tags (dict) –
      
      Tags that are attached to the container recipe.
      - (string) –
        
        (string) –
- nextToken (string) –
  
  The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

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