imagebuilder / Paginator / ListImageRecipes

ListImageRecipes

class imagebuilder.Paginator.ListImageRecipes

paginator = client.get_paginator('list_image_recipes')

paginate(**kwargs)

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

See also: AWS API Documentation

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) – You can specify the recipe owner to filter results by that owner. By default, this request will only show image recipes owned by your account. To filter by a different owner, specify one of the Valid Values that are listed for this parameter.

• 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) –

• 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',
    '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) –

    A list of ImageRecipeSummary objects that contain identifying characteristics for the image recipe, such as the name, the Amazon Resource Name (ARN), and the date created, along with other key details.

    • (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) –

    A token to resume pagination.