ECRPublic / Client / describe_registries

describe_registries#

ECRPublic.Client.describe_registries(**kwargs)#

Returns details for a public registry.

See also: AWS API Documentation

Request Syntax

response = client.describe_registries(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) –

    The nextToken value that’s returned from a previous paginated DescribeRegistries request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. If there are no more results to return, this value is null.

    Note

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

  • maxResults (integer) – The maximum number of repository results that’s returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn’t used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

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

      The nextToken value to include in a future DescribeRepositories request. If the results of a DescribeRepositories request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results, this value is null.

Exceptions

  • ECRPublic.Client.exceptions.InvalidParameterException

  • ECRPublic.Client.exceptions.UnsupportedCommandException

  • ECRPublic.Client.exceptions.ServerException