ECRPublic / Paginator / DescribeRegistries

DescribeRegistries

class ECRPublic.Paginator.DescribeRegistries

paginator = client.get_paginator('describe_registries')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ECRPublic.Client.describe_registries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'registries': [
        {
            'registryId': 'string',
            'registryArn': 'string',
            'registryUri': 'string',
            'verified': True|False,
            'aliases': [
                {
                    'name': 'string',
                    'status': 'ACTIVE'|'PENDING'|'REJECTED',
                    'primaryRegistryAlias': True|False,
                    'defaultRegistryAlias': True|False
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • registries (list) –

    An object that contains the details for a public registry.

    • (dict) –

      The details of a public registry.

      • registryId (string) –

        The Amazon Web Services account ID that’s associated with the registry. If you do not specify a registry, the default public registry is assumed.

      • registryArn (string) –

        The Amazon Resource Name (ARN) of the public registry.

      • registryUri (string) –

        The URI of a public registry. The URI contains a universal prefix and the registry alias.

      • verified (boolean) –

        Indicates whether the account is a verified Amazon Web Services Marketplace vendor. If an account is verified, each public repository receives a verified account badge on the Amazon ECR Public Gallery.

      • aliases (list) –

        An array of objects that represents the aliases for a public registry.

        • (dict) –

          An object representing the aliases for a public registry. A public registry is given an alias when it’s created. However, a custom alias can be set using the Amazon ECR console. For more information, see Registries in the Amazon Elastic Container Registry User Guide.

          • name (string) –

            The name of the registry alias.

          • status (string) –

            The status of the registry alias.

          • primaryRegistryAlias (boolean) –

            Indicates whether the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the docker pull commands on the Amazon ECR Public Gallery.

            Note

            A registry alias that isn’t the primary registry alias can be used in the repository URI in a docker pull command.

          • defaultRegistryAlias (boolean) –

            Indicates whether the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias.

  • NextToken (string) –

    A token to resume pagination.