Amazon Web Services - API Amazon EC2 Container Registry

Amazon Web Services / Amazon EC2 Container Registry

Amazon EC2 Container Registry

Amazon Elastic Container Registry

Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

License: Apache 2.0 License

Resources

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailability

Checks the availability of one or more image layers in a repository.

When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it is, then the image layer is skipped.

When an image is pulled from a repository, each image layer is checked once to verify it is available to be pulled.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailability`

Body

Name	Data Type	Description
`BatchCheckLayerAvailabilityRequest`	object

Properties


                        layerDigests

BatchedOperationLayerDigestList

The digests of the image layers to check.

BatchedOperationLayerDigestList array [BatchedOperationLayerDigest]
Minimum: 0
Maximum: 1000

BatchedOperationLayerDigest string
Minimum: 0
Maximum: 1000


                        repositoryName

RepositoryName

The name of the repository that is associated with the image layers to check.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`BatchCheckLayerAvailabilityResponse`	object

Properties


                        failures

LayerFailureList

Any failures associated with the call.

LayerFailureList array [LayerFailure]


                        LayerFailure

object

An object representing an Amazon ECR image layer failure.

Properties

`failureReason`	LayerFailureReason	The reason for the failure.
`failureCode`	LayerFailureCode	The failure code associated with the failure.
`layerDigest`	BatchedOperationLayerDigest	The layer digest associated with the failure.


                        layers

LayerList

A list of image layer objects corresponding to the image layer references in the request.

LayerList array [Layer]


                        Layer

object

An object representing an Amazon ECR image layer.

Properties

`mediaType`	MediaType	The media type of the layer, such as `application/vnd.docker.image.rootfs.diff.tar.gzip` or `application/vnd.oci.image.layer.v1.tar+gzip`.
`layerSize`	LayerSizeInBytes	The size, in bytes, of the image layer.
`layerAvailability`	LayerAvailability	The availability status of the image layer.
`layerDigest`	LayerDigest	The `sha256` digest of the image layer.

480RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchDeleteImage

Deletes a list of specified images within a repository. Images are specified with either an imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.BatchDeleteImage`

Body

Name	Data Type	Description
`BatchDeleteImageRequest`	object	Deletes specified images within a specified repository. Images are specified with either the `imageTag` or `imageDigest`.

Properties


                        imageIds

ImageIdentifierList

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The repository that contains the image to delete.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`BatchDeleteImageResponse`	object

Properties


                        failures

ImageFailureList

Any failures associated with the call.

ImageFailureList array [ImageFailure]


                        ImageFailure

object

An object representing an Amazon ECR image failure.

Properties

`failureReason`	ImageFailureReason	The reason for the failure.
`failureCode`	ImageFailureCode	The code associated with the failure.
`imageId`	ImageIdentifier	The image ID associated with the failure.


                        imageIds

ImageIdentifierList

The image IDs of the deleted images.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.

Examples

{
    "failures": [],
    "imageIds": [
        {
            "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
            "imageTag": "precise"
        }
    ]
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.BatchGetImage

Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.BatchGetImage`

Body

Name	Data Type	Description
`BatchGetImageRequest`	object

Properties


                        acceptedMediaTypes

MediaTypeList

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

MediaTypeList array [MediaType]

MediaType string


                        imageIds

ImageIdentifierList

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The repository that contains the images to describe.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`BatchGetImageResponse`	object

Properties


                        failures

ImageFailureList

Any failures associated with the call.

ImageFailureList array [ImageFailure]


                        ImageFailure

object

An object representing an Amazon ECR image failure.

Properties

`failureReason`	ImageFailureReason	The reason for the failure.
`failureCode`	ImageFailureCode	The code associated with the failure.
`imageId`	ImageIdentifier	The image ID associated with the failure.


                        images

ImageList

A list of image objects corresponding to the image references in the request.

ImageList array [Image]


                        Image

object

An object representing an Amazon ECR image.

Properties

`imageManifest`	ImageManifest	The image manifest associated with the image.
`imageId`	ImageIdentifier	An object containing the image tag and image digest associated with an image.
`repositoryName`	RepositoryName	The name of the repository associated with the image.
`registryId`	RegistryId	The AWS account ID associated with the registry containing the image.

Examples

{
    "failures": [],
    "images": [
        {
            "imageId": {
                "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
                "imageTag": "precise"
            },
            "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
            "registryId": "244698725403",
            "repositoryName": "ubuntu"
        }
    ]
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CompleteLayerUpload

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.CompleteLayerUpload`

Body

Name	Data Type	Description
`CompleteLayerUploadRequest`	object

Properties


                        layerDigests

LayerDigestList

The sha256 digest of the image layer.

LayerDigestList array [LayerDigest]
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+

LayerDigest string
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+


                        uploadId

UploadId

The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.

UploadId string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}


                        repositoryName

RepositoryName

The name of the repository to associate with the image layer.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`CompleteLayerUploadResponse`	object

Properties


                        layerDigest

LayerDigest

The sha256 digest of the image layer.

LayerDigest string
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+


                        uploadId

UploadId

The upload ID associated with the layer.

UploadId string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483UploadNotFoundException

Body

Name	Data Type	Description
`UploadNotFoundException`

484InvalidLayerException

Body

Name	Data Type	Description
`InvalidLayerException`

485LayerPartTooSmallException

Body

Name	Data Type	Description
`LayerPartTooSmallException`

486LayerAlreadyExistsException

Body

Name	Data Type	Description
`LayerAlreadyExistsException`

487EmptyUploadException

Body

Name	Data Type	Description
`EmptyUploadException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.CreateRepository

Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.CreateRepository`

Body

Name	Data Type	Description
`CreateRepositoryRequest`	object

Properties


                        imageScanningConfiguration

ImageScanningConfiguration

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.


                        ImageScanningConfiguration

object

The image scanning configuration for a repository.

Properties


                        scanOnPush

ScanOnPushFlag

The setting that determines whether images are scanned after being pushed to a repository. If set to true, images will be scanned after being pushed. If this parameter is not specified, it will default to false and images will not be scanned unless a scan is manually started with the StartImageScan API.

ScanOnPushFlag boolean


                        imageTagMutability

ImageTagMutability

The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

ImageTagMutability string
Allowed values:
- MUTABLE
- IMMUTABLE


                        tags

TagList

The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TagList array [Tag]

Tag

object

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Properties

`Value`	TagValue	The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key).
`Key`	TagKey	One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values.


                        repositoryName

RepositoryName

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

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256

Responses

200Success

Body

Name	Data Type	Description
`CreateRepositoryResponse`	object

Properties


                        repository

Repository

The repository that was created.


                        Repository

object

An object representing a repository.

Properties

imageScanningConfiguration ImageScanningConfiguration


                        ImageScanningConfiguration

object

The image scanning configuration for a repository.

Properties


                        scanOnPush

ScanOnPushFlag


                        imageTagMutability

ImageTagMutability

The tag mutability setting for the repository.

ImageTagMutability string
Allowed values:
- MUTABLE
- IMMUTABLE


                        createdAt

CreationTimestamp

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

CreationTimestamp dateTime


                        repositoryUri

Url

The URI for the repository. You can use this URI for Docker push or pull operations.

Url string


                        repositoryName

RepositoryName

The name of the repository.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository.

RegistryId string
Pattern: [0-9]{12}


                        repositoryArn

Arn

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

Arn string

Examples

{
    "repository": {
        "registryId": "012345678901",
        "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository\/project-a\/nginx-web-app",
        "repositoryName": "project-a\/nginx-web-app"
    }
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482InvalidTagParameterException

Body

Name	Data Type	Description
`InvalidTagParameterException`

483TooManyTagsException

Body

Name	Data Type	Description
`TooManyTagsException`

484RepositoryAlreadyExistsException

Body

Name	Data Type	Description
`RepositoryAlreadyExistsException`

485LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteLifecyclePolicy

Deletes the lifecycle policy associated with the specified repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DeleteLifecyclePolicy`

Body

Name	Data Type	Description
`DeleteLifecyclePolicyRequest`	object

Properties


                        repositoryName

RepositoryName

The name of the repository.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DeleteLifecyclePolicyResponse`	object

Properties


                        lastEvaluatedAt

EvaluationTimestamp

The time stamp of the last time that the lifecycle policy was run.

EvaluationTimestamp dateTime


                        lifecyclePolicyText

LifecyclePolicyText

The JSON lifecycle policy text.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483LifecyclePolicyNotFoundException

Body

Name	Data Type	Description
`LifecyclePolicyNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRepository

Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DeleteRepository`

Body

Name	Data Type	Description
`DeleteRepositoryRequest`	object

Properties


                        force

ForceFlag

If a repository contains images, forces the deletion.

ForceFlag boolean


                        repositoryName

RepositoryName

The name of the repository to delete.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

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.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DeleteRepositoryResponse`	object

Properties


                        repository

Repository

The repository that was deleted.


                        Repository

object

An object representing a repository.

Properties

imageScanningConfiguration ImageScanningConfiguration


                        ImageScanningConfiguration

object

The image scanning configuration for a repository.

Properties


                        scanOnPush

ScanOnPushFlag


                        imageTagMutability

ImageTagMutability

The tag mutability setting for the repository.

ImageTagMutability string
Allowed values:
- MUTABLE
- IMMUTABLE


                        createdAt

CreationTimestamp

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

CreationTimestamp dateTime


                        repositoryUri

Url

The URI for the repository. You can use this URI for Docker push or pull operations.

Url string


                        repositoryName

RepositoryName

The name of the repository.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository.

RegistryId string
Pattern: [0-9]{12}


                        repositoryArn

Arn

Arn string

Examples

{
    "repository": {
        "registryId": "012345678901",
        "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository\/ubuntu",
        "repositoryName": "ubuntu"
    }
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483RepositoryNotEmptyException

Body

Name	Data Type	Description
`RepositoryNotEmptyException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryPolicy

Deletes the repository policy associated with the specified repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryPolicy`

Body

Name	Data Type	Description
`DeleteRepositoryPolicyRequest`	object

Properties


                        repositoryName

RepositoryName

The name of the repository that is associated with the repository policy to delete.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DeleteRepositoryPolicyResponse`	object

Properties


                        policyText

RepositoryPolicyText

The JSON repository policy that was deleted from the repository.

RepositoryPolicyText string
Minimum: 0
Maximum: 10240


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

Examples

{
    "policyText": "{ ... }",
    "registryId": "012345678901",
    "repositoryName": "ubuntu"
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483RepositoryPolicyNotFoundException

Body

Name	Data Type	Description
`RepositoryPolicyNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImageScanFindings

Returns the scan findings for the specified image.

Request

Query

Name	Data Type	Description
`maxResults`	string	Pagination limit
`nextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DescribeImageScanFindings`

Body

Name	Data Type	Description
`DescribeImageScanFindingsRequest`	object

Properties


                        maxResults

MaxResults

The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings 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 DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

MaxResults integer
Minimum: 1
Maximum: 1000


                        nextToken

NextToken

The nextToken value returned from a previous paginated DescribeImageScanFindings 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.

NextToken string

imageId ImageIdentifier


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The repository for the image for which to describe the scan findings.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DescribeImageScanFindingsResponse`	object

Properties


                        nextToken

NextToken

The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings 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.

NextToken string


                        imageScanFindings

ImageScanFindings

The information contained in the image scan findings.


                        ImageScanFindings

object

The details of an image scan.

Properties


                        findingSeverityCounts

FindingSeverityCounts

The image vulnerability counts, sorted by severity.

FindingSeverityCounts object

Extends

SeverityCount

Name	Data Type	Description
`SeverityCount`	integer Minimum: 0


                        findings

ImageScanFindingList

The findings from the image scan.

ImageScanFindingList array [ImageScanFinding]


                        vulnerabilitySourceUpdatedAt

VulnerabilitySourceUpdateTimestamp

The time when the vulnerability data was last scanned.

VulnerabilitySourceUpdateTimestamp dateTime


                        imageScanCompletedAt

ScanTimestamp

The time of the last completed image scan.

ScanTimestamp dateTime


                        imageScanStatus

ImageScanStatus

The current state of the scan.


                        ImageScanStatus

object

The current status of an image scan.

Properties


                        description

ScanStatusDescription

The description of the image scan status.

ScanStatusDescription string


                        status

ScanStatus

The current state of an image scan.

ScanStatus string
Allowed values:
- IN_PROGRESS
- COMPLETE
- FAILED

imageId ImageIdentifier


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483ImageNotFoundException

Body

Name	Data Type	Description
`ImageNotFoundException`

484ScanNotFoundException

Body

Name	Data Type	Description
`ScanNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeImages

Returns metadata about the images in a repository.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

Request

Query

Name	Data Type	Description
`maxResults`	string	Pagination limit
`nextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DescribeImages`

Body

Name	Data Type	Description
`DescribeImagesRequest`	object

Properties


                        filter

DescribeImagesFilter

The filter key and value with which to filter your DescribeImages results.


                        DescribeImagesFilter

object

An object representing a filter on a DescribeImages operation.

Properties


                        tagStatus

TagStatus

The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

TagStatus string
Allowed values:
- TAGGED
- UNTAGGED
- ANY


                        maxResults

MaxResults

The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages 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 DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

MaxResults integer
Minimum: 1
Maximum: 1000


                        nextToken

NextToken

The nextToken value returned from a previous paginated DescribeImages 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. This option cannot be used when you specify images with imageIds.

NextToken string


                        imageIds

ImageIdentifierList

The list of image IDs for the requested repository.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The repository that contains the images to describe.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DescribeImagesResponse`	object

Properties


                        nextToken

NextToken

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages 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.

NextToken string


                        imageDetails

ImageDetailList

A list of ImageDetail objects that contain data about the image.

ImageDetailList array [ImageDetail]


                        ImageDetail

object

An object that describes an image returned by a DescribeImages operation.

Properties

`imageScanFindingsSummary`	ImageScanFindingsSummary	A summary of the last completed image scan.
`imageScanStatus`	ImageScanStatus	The current state of the scan.
`imagePushedAt`	PushTimestamp	The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
`imageSizeInBytes`	ImageSizeInBytes	The size, in bytes, of the image in the repository. Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the `docker images` command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
`imageTags`	ImageTagList	The list of tags associated with this image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.
`repositoryName`	RepositoryName	The name of the repository to which this image belongs.
`registryId`	RegistryId	The AWS account ID associated with the registry to which this image belongs.

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483ImageNotFoundException

Body

Name	Data Type	Description
`ImageNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.DescribeRepositories

Describes image repositories in a registry.

Request

Query

Name	Data Type	Description
`maxResults`	string	Pagination limit
`nextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.DescribeRepositories`

Body

Name	Data Type	Description
`DescribeRepositoriesRequest`	object

Properties


                        maxResults

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 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

MaxResults integer
Minimum: 1
Maximum: 1000


                        nextToken

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. This option cannot be used when you specify repositories with repositoryNames.

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.

NextToken string


                        repositoryNames

RepositoryNameList

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

RepositoryNameList array [RepositoryName]
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

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.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`DescribeRepositoriesResponse`	object

Properties


                        nextToken

NextToken

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.

NextToken string


                        repositories

RepositoryList

A list of repository objects corresponding to valid repositories.

RepositoryList array [Repository]


                        Repository

object

An object representing a repository.

Properties

`imageScanningConfiguration`	ImageScanningConfiguration
`imageTagMutability`	ImageTagMutability	The tag mutability setting for the repository.
`createdAt`	CreationTimestamp	The date and time, in JavaScript date format, when the repository was created.
`repositoryUri`	Url	The URI for the repository. You can use this URI for Docker `push` or `pull` operations.
`repositoryName`	RepositoryName	The name of the repository.
`registryId`	RegistryId	The AWS account ID associated with the registry that contains the repository.
`repositoryArn`	Arn	The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the `arn:aws:ecr` namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, `arn:aws:ecr:region:012345678910:repository/test`.

Examples

{
    "repositories": [
        {
            "registryId": "012345678910",
            "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository\/ubuntu",
            "repositoryName": "ubuntu"
        },
        {
            "registryId": "012345678910",
            "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository\/test",
            "repositoryName": "test"
        }
    ]
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetAuthorizationToken

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.

The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.GetAuthorizationToken`

Body

Name	Data Type	Description
`GetAuthorizationTokenRequest`	object

Properties


                        registryIds

GetAuthorizationTokenRegistryIdList

A list of AWS account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

GetAuthorizationTokenRegistryIdList array [RegistryId]
Pattern: [0-9]{12}

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`GetAuthorizationTokenResponse`	object

Properties


                        authorizationData

AuthorizationDataList

A list of authorization token data objects that correspond to the registryIds values in the request.

AuthorizationDataList array [AuthorizationData]


                        AuthorizationData

object

An object representing authorization data for an Amazon ECR registry.

Properties

`proxyEndpoint`	ProxyEndpoint	The registry URL to use for this authorization token in a `docker login` command. The Amazon ECR registry URL format is `https://aws_account_id.dkr.ecr.region.amazonaws.com`. For example, `https://012345678910.dkr.ecr.us-east-1.amazonaws.com`..
`expiresAt`	ExpirationTimestamp	The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
`authorizationToken`	Base64	A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format `user:password` for private registry authentication using `docker login`.

Examples

{
    "authorizationData": [
        {
            "authorizationToken": "QVdTOkN...",
            "expiresAt": "1470951892432",
            "proxyEndpoint": "https:\/\/012345678901.dkr.ecr.us-west-2.amazonaws.com"
        }
    ]
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetDownloadUrlForLayer

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.GetDownloadUrlForLayer`

Body

Name	Data Type	Description
`GetDownloadUrlForLayerRequest`	object

Properties


                        layerDigest

LayerDigest

The digest of the image layer to download.

LayerDigest string
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+


                        repositoryName

RepositoryName

The name of the repository that is associated with the image layer to download.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`GetDownloadUrlForLayerResponse`	object

Properties


                        layerDigest

LayerDigest

The digest of the image layer to download.

LayerDigest string
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+


                        downloadUrl

Url

The pre-signed Amazon S3 download URL for the requested layer.

Url string

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482LayersNotFoundException

Body

Name	Data Type	Description
`LayersNotFoundException`

483LayerInaccessibleException

Body

Name	Data Type	Description
`LayerInaccessibleException`

484RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicy

Retrieves the lifecycle policy for the specified repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicy`

Body

Name	Data Type	Description
`GetLifecyclePolicyRequest`	object

Properties


                        repositoryName

RepositoryName

The name of the repository.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`GetLifecyclePolicyResponse`	object

Properties


                        lastEvaluatedAt

EvaluationTimestamp

The time stamp of the last time that the lifecycle policy was run.

EvaluationTimestamp dateTime


                        lifecyclePolicyText

LifecyclePolicyText

The JSON lifecycle policy text.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483LifecyclePolicyNotFoundException

Body

Name	Data Type	Description
`LifecyclePolicyNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyPreview

Retrieves the results of the lifecycle policy preview request for the specified repository.

Request

Query

Name	Data Type	Description
`maxResults`	string	Pagination limit
`nextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyPreview`

Body

Name	Data Type	Description
`GetLifecyclePolicyPreviewRequest`	object

Properties


                        filter

LifecyclePolicyPreviewFilter

An optional parameter that filters results based on image tag status and all tags, if tagged.


                        LifecyclePolicyPreviewFilter

object

The filter for the lifecycle policy preview.

Properties


                        tagStatus

TagStatus

The tag status of the image.

TagStatus string
Allowed values:
- TAGGED
- UNTAGGED
- ANY


                        maxResults

LifecyclePreviewMaxResults

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in  paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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 GetLifecyclePolicyPreviewRequest request with the returned nextToken  value. This value can be between 1 and 1000. If this  parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken value, if  applicable. This option cannot be used when you specify images with imageIds.

LifecyclePreviewMaxResults integer
Minimum: 1
Maximum: 100


                        nextToken

NextToken

The nextToken value returned from a previous paginated  GetLifecyclePolicyPreviewRequest 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. This option cannot be used when you specify images with imageIds.

NextToken string


                        imageIds

ImageIdentifierList

The list of imageIDs to be included.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The name of the repository.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`GetLifecyclePolicyPreviewResponse`	object

Properties


                        summary

LifecyclePolicyPreviewSummary

The list of images that is returned as a result of the action.


                        LifecyclePolicyPreviewSummary

object

The summary of the lifecycle policy preview request.

Properties


                        expiringImageTotalCount

ImageCount

The number of expiring images.

ImageCount integer
Minimum: 0


                        previewResults

LifecyclePolicyPreviewResultList

The results of the lifecycle policy preview request.

LifecyclePolicyPreviewResultList array [LifecyclePolicyPreviewResult]


                        LifecyclePolicyPreviewResult

object

The result of the lifecycle policy preview.

Properties

`appliedRulePriority`	LifecyclePolicyRulePriority	The priority of the applied rule.
`action`	LifecyclePolicyRuleAction	The type of action to be taken.
`imagePushedAt`	PushTimestamp	The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.
`imageTags`	ImageTagList	The list of tags associated with this image.


                        nextToken

NextToken

The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview 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.

NextToken string


                        status

LifecyclePolicyPreviewStatus

The status of the lifecycle policy preview request.

LifecyclePolicyPreviewStatus string
Allowed values:
- IN_PROGRESS
- COMPLETE
- EXPIRED
- FAILED


                        lifecyclePolicyText

LifecyclePolicyText

The JSON lifecycle policy text.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483LifecyclePolicyPreviewNotFoundException

Body

Name	Data Type	Description
`LifecyclePolicyPreviewNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.GetRepositoryPolicy

Retrieves the repository policy for the specified repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.GetRepositoryPolicy`

Body

Name	Data Type	Description
`GetRepositoryPolicyRequest`	object

Properties


                        repositoryName

RepositoryName

The name of the repository with the policy to retrieve.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`GetRepositoryPolicyResponse`	object

Properties


                        policyText

RepositoryPolicyText

The JSON repository policy text associated with the repository.

RepositoryPolicyText string
Minimum: 0
Maximum: 10240


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

Examples

{
    "policyText": "{\n  \"Version\" : \"2008-10-17\",\n  \"Statement\" : [ {\n    \"Sid\" : \"new statement\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n     \"AWS\" : \"arn:aws:iam::012345678901:role\/CodeDeployDemo\"\n    },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}",
    "registryId": "012345678901",
    "repositoryName": "ubuntu"
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483RepositoryPolicyNotFoundException

Body

Name	Data Type	Description
`RepositoryPolicyNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.InitiateLayerUpload

Notifies Amazon ECR that you intend to upload an image layer.

When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether an image layer has been uploaded before is determined by the BatchCheckLayerAvailability API action.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.InitiateLayerUpload`

Body

Name	Data Type	Description
`InitiateLayerUploadRequest`	object

Properties


                        repositoryName

RepositoryName

The name of the repository to which you intend to upload layers.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`InitiateLayerUploadResponse`	object

Properties


                        partSize

PartSize

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

PartSize integer
Minimum: 0


                        uploadId

UploadId

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

UploadId string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListImages

Lists all the image IDs for the specified repository.

You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Request

Query

Name	Data Type	Description
`maxResults`	string	Pagination limit
`nextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.ListImages`

Body

Name	Data Type	Description
`ListImagesRequest`	object

Properties


                        filter

ListImagesFilter

The filter key and value with which to filter your ListImages results.


                        ListImagesFilter

object

An object representing a filter on a ListImages operation.

Properties


                        tagStatus

TagStatus

The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

TagStatus string
Allowed values:
- TAGGED
- UNTAGGED
- ANY


                        maxResults

MaxResults

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

MaxResults integer
Minimum: 1
Maximum: 1000


                        nextToken

NextToken

The nextToken value returned from a previous paginated ListImages 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.

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.

NextToken string


                        repositoryName

RepositoryName

The repository with image IDs to be listed.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`ListImagesResponse`	object

Properties


                        nextToken

NextToken

The nextToken value to include in a future ListImages request. When the results of a ListImages 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.

NextToken string


                        imageIds

ImageIdentifierList

The list of image IDs for the requested repository.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.

Examples

{
    "imageIds": [
        {
            "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a",
            "imageTag": "precise"
        }
    ]
}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.ListTagsForResource

List the tags for an Amazon ECR resource.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.ListTagsForResource`

Body

Name	Data Type	Description
`ListTagsForResourceRequest`	object

Properties


                        resourceArn

Arn

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.

Arn string

Responses

200Success

Body

Name	Data Type	Description
`ListTagsForResourceResponse`	object

Properties


                        tags

TagList

The tags for the resource.

TagList array [Tag]

Tag

object

Properties

`Value`	TagValue	The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key).
`Key`	TagKey	One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

482ServerException

Body

Name	Data Type	Description
`ServerException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImage

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and tags associated with the image.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.PutImage`

Body

Name	Data Type	Description
`PutImageRequest`	object

Properties


                        imageTag

ImageTag

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.

ImageTag string
Minimum: 1
Maximum: 300


                        imageManifest

ImageManifest

The image manifest corresponding to the image to be uploaded.

ImageManifest string
Minimum: 1
Maximum: 4194304


                        repositoryName

RepositoryName

The name of the repository in which to put the image.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`PutImageResponse`	object

Properties


                        image

Image

Details of the image uploaded.


                        Image

object

An object representing an Amazon ECR image.

Properties


                        imageManifest

ImageManifest

The image manifest associated with the image.

ImageManifest string
Minimum: 1
Maximum: 4194304


                        imageId

ImageIdentifier

An object containing the image tag and image digest associated with an image.


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The name of the repository associated with the image.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry containing the image.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483ImageAlreadyExistsException

Body

Name	Data Type	Description
`ImageAlreadyExistsException`

484LayersNotFoundException

Body

Name	Data Type	Description
`LayersNotFoundException`

485LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

486ImageTagAlreadyExistsException

Body

Name	Data Type	Description
`ImageTagAlreadyExistsException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImageScanningConfiguration

Updates the image scanning configuration for the specified repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.PutImageScanningConfiguration`

Body

Name	Data Type	Description
`PutImageScanningConfigurationRequest`	object

Properties


                        imageScanningConfiguration

ImageScanningConfiguration

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.


                        ImageScanningConfiguration

object

The image scanning configuration for a repository.

Properties


                        scanOnPush

ScanOnPushFlag

ScanOnPushFlag boolean


                        repositoryName

RepositoryName

The name of the repository in which to update the image scanning configuration setting.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`PutImageScanningConfigurationResponse`	object

Properties


                        imageScanningConfiguration

ImageScanningConfiguration

The image scanning configuration setting for the repository.


                        ImageScanningConfiguration

object

The image scanning configuration for a repository.

Properties


                        scanOnPush

ScanOnPushFlag

ScanOnPushFlag boolean


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutImageTagMutability

Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.PutImageTagMutability`

Body

Name	Data Type	Description
`PutImageTagMutabilityRequest`	object

Properties


                        imageTagMutability

ImageTagMutability

The tag mutability setting for the repository. If MUTABLE is specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

ImageTagMutability string
Allowed values:
- MUTABLE
- IMMUTABLE


                        repositoryName

RepositoryName

The name of the repository in which to update the image tag mutability settings.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`PutImageTagMutabilityResponse`	object

Properties


                        imageTagMutability

ImageTagMutability

The image tag mutability setting for the repository.

ImageTagMutability string
Allowed values:
- MUTABLE
- IMMUTABLE


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.PutLifecyclePolicy

Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.PutLifecyclePolicy`

Body

Name	Data Type	Description
`PutLifecyclePolicyRequest`	object

Properties


                        lifecyclePolicyText

LifecyclePolicyText

The JSON repository policy text to apply to the repository.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The name of the repository to receive the policy.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`PutLifecyclePolicyResponse`	object

Properties


                        lifecyclePolicyText

LifecyclePolicyText

The JSON repository policy text.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.SetRepositoryPolicy

Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.SetRepositoryPolicy`

Body

Name	Data Type	Description
`SetRepositoryPolicyRequest`	object

Properties


                        force

ForceFlag

If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.

ForceFlag boolean


                        policyText

RepositoryPolicyText

The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policy Examples in the Amazon Elastic Container Registry User Guide.

RepositoryPolicyText string
Minimum: 0
Maximum: 10240


                        repositoryName

RepositoryName

The name of the repository to receive the policy.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`SetRepositoryPolicyResponse`	object

Properties


                        policyText

RepositoryPolicyText

The JSON repository policy text applied to the repository.

RepositoryPolicyText string
Minimum: 0
Maximum: 10240


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StartImageScan

Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.StartImageScan`

Body

Name	Data Type	Description
`StartImageScanRequest`	object

Properties

imageId ImageIdentifier


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The name of the repository that contains the images to scan.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`StartImageScanResponse`	object

Properties


                        imageScanStatus

ImageScanStatus

The current state of the scan.


                        ImageScanStatus

object

The current status of an image scan.

Properties


                        description

ScanStatusDescription

The description of the image scan status.

ScanStatusDescription string


                        status

ScanStatus

The current state of an image scan.

ScanStatus string
Allowed values:
- IN_PROGRESS
- COMPLETE
- FAILED

imageId ImageIdentifier


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483ImageNotFoundException

Body

Name	Data Type	Description
`ImageNotFoundException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.StartLifecyclePolicyPreview

Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.StartLifecyclePolicyPreview`

Body

Name	Data Type	Description
`StartLifecyclePolicyPreviewRequest`	object

Properties


                        lifecyclePolicyText

LifecyclePolicyText

The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The name of the repository to be evaluated.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`StartLifecyclePolicyPreviewResponse`	object

Properties


                        status

LifecyclePolicyPreviewStatus

The status of the lifecycle policy preview request.

LifecyclePolicyPreviewStatus string
Allowed values:
- IN_PROGRESS
- COMPLETE
- EXPIRED
- FAILED


                        lifecyclePolicyText

LifecyclePolicyText

The JSON repository policy text.

LifecyclePolicyText string
Minimum: 100
Maximum: 30720


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

483LifecyclePolicyNotFoundException

Body

Name	Data Type	Description
`LifecyclePolicyNotFoundException`

484LifecyclePolicyPreviewInProgressException

Body

Name	Data Type	Description
`LifecyclePolicyPreviewInProgressException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.TagResource

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.TagResource`

Body

Name	Data Type	Description
`TagResourceRequest`	object

Properties


                        tags

TagList

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TagList array [Tag]

Tag

object

Properties

`Value`	TagValue	The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key).
`Key`	TagKey	One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values.


                        resourceArn

Arn

The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.

Arn string

Responses

200Success

Body

Name	Data Type	Description
`TagResourceResponse`	object

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InvalidTagParameterException

Body

Name	Data Type	Description
`InvalidTagParameterException`

482TooManyTagsException

Body

Name	Data Type	Description
`TooManyTagsException`

483RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

484ServerException

Body

Name	Data Type	Description
`ServerException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UntagResource

Deletes specified tags from a resource.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.UntagResource`

Body

Name	Data Type	Description
`UntagResourceRequest`	object

Properties


                        tagKeys

TagKeyList

The keys of the tags to be removed.

TagKeyList array [TagKey]

TagKey string


                        resourceArn

Arn

The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.

Arn string

Responses

200Success

Body

Name	Data Type	Description
`UntagResourceResponse`	object

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InvalidTagParameterException

Body

Name	Data Type	Description
`InvalidTagParameterException`

482TooManyTagsException

Body

Name	Data Type	Description
`TooManyTagsException`

483RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

484ServerException

Body

Name	Data Type	Description
`ServerException`

POST

/#X-Amz-Target=AmazonEC2ContainerRegistry_V20150921.UploadLayerPart

Uploads an image layer part to Amazon ECR.

When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.

Request

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string
`X-Amz-Target`	string Allowed values: - `AmazonEC2ContainerRegistry_V20150921.UploadLayerPart`

Body

Name	Data Type	Description
`UploadLayerPartRequest`	object

Properties


                        layerPartBlob

LayerPartBlob

The base64-encoded layer part payload.

LayerPartBlob string
Minimum: 0
Maximum: 20971520


                        partLastByte

PartSize

The integer value of the last byte of the layer part.

PartSize integer
Minimum: 0


                        partFirstByte

PartSize

The integer value of the first byte of the layer part.

PartSize integer
Minimum: 0


                        uploadId

UploadId

The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

UploadId string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}


                        repositoryName

RepositoryName

The name of the repository to which you are uploading layer parts.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.

RegistryId string
Pattern: [0-9]{12}

Responses

200Success

Body

Name	Data Type	Description
`UploadLayerPartResponse`	object

Properties


                        lastByteReceived

PartSize

The integer value of the last byte received in the request.

PartSize integer
Minimum: 0


                        uploadId

UploadId

The upload ID associated with the request.

UploadId string
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}


                        repositoryName

RepositoryName

The repository name associated with the request.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The registry ID associated with the request.

RegistryId string
Pattern: [0-9]{12}

480ServerException

Body

Name	Data Type	Description
`ServerException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482InvalidLayerPartException

Body

Name	Data Type	Description
`InvalidLayerPartException`

483RepositoryNotFoundException

Body

Name	Data Type	Description
`RepositoryNotFoundException`

484UploadNotFoundException

Body

Name	Data Type	Description
`UploadNotFoundException`

485LimitExceededException

Body

Name	Data Type	Description
`LimitExceededException`

Models

Arn

Attribute

AttributeKey

AttributeList

Name Data Type Description

AttributeList array [Attribute]


                        Attribute

object

This data type is used in the ImageScanFinding data type.

Properties


                        value

AttributeValue

The value assigned to the attribute key.

AttributeValue string
Minimum: 1
Maximum: 256

key

AttributeKey

The attribute key.

AttributeKey string
Minimum: 1
Maximum: 128

AttributeValue

AuthorizationData

An object representing authorization data for an Amazon ECR registry.

Properties

Name Data Type Description


                        proxyEndpoint

ProxyEndpoint

The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

ProxyEndpoint string


                        expiresAt

ExpirationTimestamp

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

ExpirationTimestamp dateTime


                        authorizationToken

Base64

A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.

Base64 string
Pattern: ^\S+$

AuthorizationDataList

Name Data Type Description

AuthorizationDataList array [AuthorizationData]


                        AuthorizationData

object

An object representing authorization data for an Amazon ECR registry.

Properties


                        proxyEndpoint

ProxyEndpoint

ProxyEndpoint string


                        expiresAt

ExpirationTimestamp

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

ExpirationTimestamp dateTime


                        authorizationToken

Base64

Base64 string
Pattern: ^\S+$

Base64

BatchCheckLayerAvailabilityRequest

Properties

Name Data Type Description


                        layerDigests

BatchedOperationLayerDigestList

The digests of the image layers to check.

BatchedOperationLayerDigestList array [BatchedOperationLayerDigest]
Minimum: 0
Maximum: 1000

BatchedOperationLayerDigest string
Minimum: 0
Maximum: 1000


                        repositoryName

RepositoryName

The name of the repository that is associated with the image layers to check.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

BatchCheckLayerAvailabilityResponse

Properties

Name Data Type Description


                        failures

LayerFailureList

Any failures associated with the call.

LayerFailureList array [LayerFailure]


                        LayerFailure

object

An object representing an Amazon ECR image layer failure.

Properties


                        failureReason

LayerFailureReason

The reason for the failure.

LayerFailureReason string


                        failureCode

LayerFailureCode

The failure code associated with the failure.

LayerFailureCode string
Allowed values:
- InvalidLayerDigest
- MissingLayerDigest


                        layerDigest

BatchedOperationLayerDigest

The layer digest associated with the failure.

BatchedOperationLayerDigest string
Minimum: 0
Maximum: 1000


                        layers

LayerList

A list of image layer objects corresponding to the image layer references in the request.

LayerList array [Layer]


                        Layer

object

An object representing an Amazon ECR image layer.

Properties


                        mediaType

MediaType

The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.

MediaType string


                        layerSize

LayerSizeInBytes

The size, in bytes, of the image layer.

LayerSizeInBytes integer


                        layerAvailability

LayerAvailability

The availability status of the image layer.

LayerAvailability string
Allowed values:
- AVAILABLE
- UNAVAILABLE


                        layerDigest

LayerDigest

The sha256 digest of the image layer.

LayerDigest string
Pattern: [a-zA-Z0-9-_+.]+:[a-fA-F0-9]+

BatchDeleteImageRequest

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

Properties

Name Data Type Description


                        imageIds

ImageIdentifierList

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The repository that contains the image to delete.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

BatchDeleteImageResponse

Properties

Name Data Type Description


                        failures

ImageFailureList

Any failures associated with the call.

ImageFailureList array [ImageFailure]


                        ImageFailure

object

An object representing an Amazon ECR image failure.

Properties


                        failureReason

ImageFailureReason

The reason for the failure.

ImageFailureReason string


                        failureCode

ImageFailureCode

The code associated with the failure.

ImageFailureCode string
Allowed values:
- InvalidImageDigest
- InvalidImageTag
- ImageTagDoesNotMatchDigest
- ImageNotFound
- MissingDigestAndTag


                        imageId

ImageIdentifier

The image ID associated with the failure.


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        imageIds

ImageIdentifierList

The image IDs of the deleted images.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string

Examples

{
    "failures": [],
    "imageIds": [
        {
            "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
            "imageTag": "precise"
        }
    ]
}

BatchGetImageRequest

Properties

Name Data Type Description


                        acceptedMediaTypes

MediaTypeList

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

MediaTypeList array [MediaType]

MediaType string


                        imageIds

ImageIdentifierList

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

ImageIdentifierList array [ImageIdentifier]


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties


                        imageTag

ImageTag

The tag used for the image.

ImageTag string
Minimum: 1
Maximum: 300


                        imageDigest

ImageDigest

The sha256 digest of the image manifest.

ImageDigest string


                        repositoryName

RepositoryName

The repository that contains the images to describe.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

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

RegistryId string
Pattern: [0-9]{12}

BatchGetImageResponse

Properties

Name Data Type Description


                        failures

ImageFailureList

Any failures associated with the call.

ImageFailureList array [ImageFailure]


                        ImageFailure

object

An object representing an Amazon ECR image failure.

Properties


                        failureReason

ImageFailureReason

The reason for the failure.

ImageFailureReason string


                        failureCode

ImageFailureCode

The code associated with the failure.

ImageFailureCode string
Allowed values:
- InvalidImageDigest
- InvalidImageTag
- ImageTagDoesNotMatchDigest
- ImageNotFound
- MissingDigestAndTag


                        imageId

ImageIdentifier

The image ID associated with the failure.


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        images

ImageList

A list of image objects corresponding to the image references in the request.

ImageList array [Image]


                        Image

object

An object representing an Amazon ECR image.

Properties


                        imageManifest

ImageManifest

The image manifest associated with the image.

ImageManifest string
Minimum: 1
Maximum: 4194304


                        imageId

ImageIdentifier

An object containing the image tag and image digest associated with an image.


                        ImageIdentifier

object

An object with identifying information for an Amazon ECR image.

Properties

`imageTag`	ImageTag	The tag used for the image.
`imageDigest`	ImageDigest	The `sha256` digest of the image manifest.


                        repositoryName

RepositoryName

The name of the repository associated with the image.

RepositoryName string
Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Minimum: 2
Maximum: 256


                        registryId

RegistryId

The AWS account ID associated with the registry containing the image.

RegistryId string
Pattern: [0-9]{12}

Examples

{
    "failures": [],
    "images": [
        {
            "imageId": {
                "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
                "imageTag": "precise"
            },
            "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
            "registryId": "244698725403",
            "repositoryName": "ubuntu"
        }
    ]
}

BatchedOperationLayerDigest

BatchedOperationLayerDigestList

CompleteLayerUploadRequest