Amazon EC2 Container Registry

{'repository': {'repositoryUri': 'string'}}

Creates an image repository.

Request Syntax

client.create_repository(
    repositoryName='string'
)

type repositoryName:

string

param repositoryName:

[REQUIRED]

The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

rtype:

dict

returns:

Response Syntax

{
    'repository': {
        'repositoryArn': 'string',
        'registryId': 'string',
        'repositoryName': 'string',
        'repositoryUri': 'string'
    }
}

Response Structure

• (dict) --

  • repository (dict) --

    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, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

    • registryId (string) --

      The AWS account ID associated with the 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 Docker push and pull operations.

{'repository': {'repositoryUri': 'string'}}

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

Request Syntax

client.delete_repository(
    registryId='string',
    repositoryName='string',
    force=True|False
)

type registryId:

string

param registryId:

The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.

type repositoryName:

string

param repositoryName:

[REQUIRED]

The name of the repository to delete.

type force:

boolean

param force:

Force the deletion of the repository if it contains images.

rtype:

dict

returns:

Response Syntax

{
    'repository': {
        'repositoryArn': 'string',
        'registryId': 'string',
        'repositoryName': 'string',
        'repositoryUri': 'string'
    }
}

Response Structure

• (dict) --

  • repository (dict) --

    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, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

    • registryId (string) --

      The AWS account ID associated with the 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 Docker push and pull operations.

{'repositories': {'repositoryUri': 'string'}}

Describes image repositories in a registry.

Request Syntax

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

type registryId:

string

param registryId:

The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

type repositoryNames:

list

param repositoryNames:

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

• (string) --

type nextToken:

string

param nextToken:

The nextToken value 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. This value is null when there are no more results to return.

type maxResults:

integer

param maxResults:

The maximum number of repository results 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. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable.

rtype:

dict

returns:

Response Syntax

{
    'repositories': [
        {
            'repositoryArn': 'string',
            'registryId': 'string',
            'repositoryName': 'string',
            'repositoryUri': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • repositories (list) --

    A list of repository objects corresponding to valid repositories.

    • (dict) --

      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, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

      • registryId (string) --

        The AWS account ID associated with the 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 Docker push and pull operations.

  • 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. This value is null when there are no more results to return.