imagebuilder / Client / list_image_recipes

list_image_recipes#

imagebuilder.Client.list_image_recipes(**kwargs)#

Returns a list of image recipes.

Request Syntax

response = client.list_image_recipes(
    owner='Self'|'Shared'|'Amazon'|'ThirdParty',
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

owner (string) – The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.
filters (list) –
Use the following filters to streamline results:
- 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 items to return in a request.
nextToken (string) – A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Return type:

dict

Returns:

Response Syntax

{
    'requestId': 'string',
    'imageRecipeSummaryList': [
        {
            'arn': 'string',
            'name': 'string',
            'platform': 'Windows'|'Linux'|'macOS',
            'owner': 'string',
            'parentImage': 'string',
            'dateCreated': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- requestId (string) –
  
  The request ID that uniquely identifies this request.
- imageRecipeSummaryList (list) –
  
  The list of image pipelines.
  - (dict) –
    
    A summary of an image recipe.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the image recipe.
    - name (string) –
      
      The name of the image recipe.
    - platform (string) –
      
      The platform of the image recipe.
    - owner (string) –
      
      The owner of the image recipe.
    - parentImage (string) –
      
      The base image of the image recipe.
    - dateCreated (string) –
      
      The date on which this image recipe was created.
    - tags (dict) –
      
      The tags of the image recipe.
      - (string) –
        
        (string) –
- 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