describe_repositories

ECRPublic.Client.describe_repositories(**kwargs)

Describes repositories that are in a public registry.

See also: AWS API Documentation

Request Syntax

response = client.describe_repositories(
    registryId='string',
    repositoryNames=[
        'string',
    ],
    nextToken='string',
    maxResults=123
)

Parameters

• registryId (string) -- The Amazon Web Services account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.
• repositoryNames (list) --

  A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

  • (string) --
• nextToken (string) --

  The nextToken value that's returned from a previous paginated DescribeRepositories 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 . If you specify repositories with repositoryNames , you can't use this option.

  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 DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. If you specify repositories with repositoryNames , you can't use this option.

Return type

dict

Returns

Response Syntax

{
    'repositories': [
        {
            'repositoryArn': 'string',
            'registryId': 'string',
            'repositoryName': 'string',
            'repositoryUri': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • repositories (list) --

    A list of repository objects corresponding to valid repositories.

    • (dict) --

      An object representing a repository.

      • repositoryArn (string) --

        The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test .

      • registryId (string) --

        The Amazon Web Services account ID that's associated with the public registry that contains the repository.

      • repositoryName (string) --

        The name of the repository.

      • repositoryUri (string) --

        The URI for the repository. You can use this URI for container image push and pull operations.

      • createdAt (datetime) --

        The date and time, in JavaScript date format, when the repository was created.

  • nextToken (string) --

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

Exceptions

• ECRPublic.Client.exceptions.ServerException
• ECRPublic.Client.exceptions.InvalidParameterException
• ECRPublic.Client.exceptions.RepositoryNotFoundException
• ECRPublic.Client.exceptions.UnsupportedCommandException