ECR / Client / describe_registry

describe_registry#

ECR.Client.describe_registry()#

Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.

See also: AWS API Documentation

Request Syntax

response = client.describe_registry()
Return type:

dict

Returns:

Response Syntax

{
    'registryId': 'string',
    'replicationConfiguration': {
        'rules': [
            {
                'destinations': [
                    {
                        'region': 'string',
                        'registryId': 'string'
                    },
                ],
                'repositoryFilters': [
                    {
                        'filter': 'string',
                        'filterType': 'PREFIX_MATCH'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • registryId (string) –

      The registry ID associated with the request.

    • replicationConfiguration (dict) –

      The replication configuration for the registry.

      • rules (list) –

        An array of objects representing the replication destinations and repository filters for a replication configuration.

        • (dict) –

          An array of objects representing the replication destinations and repository filters for a replication configuration.

          • destinations (list) –

            An array of objects representing the destination for a replication rule.

            • (dict) –

              An array of objects representing the destination for a replication rule.

              • region (string) –

                The Region to replicate to.

              • registryId (string) –

                The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

          • repositoryFilters (list) –

            An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

            • (dict) –

              The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.

              • filter (string) –

                The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

              • filterType (string) –

                The repository filter type. The only supported value is PREFIX_MATCH, which is a repository name prefix specified with the filter parameter.

Exceptions

  • ECR.Client.exceptions.ServerException

  • ECR.Client.exceptions.InvalidParameterException

  • ECR.Client.exceptions.ValidationException