{ "version":"2.0", "metadata":{ "apiVersion":"2015-09-21", "endpointPrefix":"ecr", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon ECR", "serviceFullName":"Amazon EC2 Container Registry", "signatureVersion":"v4", "targetPrefix":"AmazonEC2ContainerRegistry_V20150921" }, "operations":{ "BatchCheckLayerAvailability":{ "name":"BatchCheckLayerAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchCheckLayerAvailabilityRequest"}, "output":{"shape":"BatchCheckLayerAvailabilityResponse"}, "errors":[ {"shape":"RepositoryNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerException"} ], "documentation":"

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" }, "BatchDeleteImage":{ "name":"BatchDeleteImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDeleteImageRequest"}, "output":{"shape":"BatchDeleteImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

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

" }, "BatchGetImage":{ "name":"BatchGetImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetImageRequest"}, "output":{"shape":"BatchGetImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

" }, "CompleteLayerUpload":{ "name":"CompleteLayerUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CompleteLayerUploadRequest"}, "output":{"shape":"CompleteLayerUploadResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"UploadNotFoundException"}, {"shape":"InvalidLayerException"}, {"shape":"LayerPartTooSmallException"}, {"shape":"LayerAlreadyExistsException"}, {"shape":"EmptyUploadException"} ], "documentation":"

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

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" }, "CreateRepository":{ "name":"CreateRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRepositoryRequest"}, "output":{"shape":"CreateRepositoryResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryAlreadyExistsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an image repository.

" }, "DeleteRepository":{ "name":"DeleteRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRepositoryRequest"}, "output":{"shape":"DeleteRepositoryResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryNotEmptyException"} ], "documentation":"

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

" }, "DeleteRepositoryPolicy":{ "name":"DeleteRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRepositoryPolicyRequest"}, "output":{"shape":"DeleteRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryPolicyNotFoundException"} ], "documentation":"

Deletes the repository policy from a specified repository.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"ImageNotFoundException"} ], "documentation":"

Returns metadata about the images in a repository, including image size and creation date.

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.

" }, "DescribeRepositories":{ "name":"DescribeRepositories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRepositoriesRequest"}, "output":{"shape":"DescribeRepositoriesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Describes image repositories in a registry.

" }, "GetAuthorizationToken":{ "name":"GetAuthorizationToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAuthorizationTokenRequest"}, "output":{"shape":"GetAuthorizationTokenResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified 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 aws ecr get-login command that simplifies the login process.

" }, "GetDownloadUrlForLayer":{ "name":"GetDownloadUrlForLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDownloadUrlForLayerRequest"}, "output":{"shape":"GetDownloadUrlForLayerResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"LayersNotFoundException"}, {"shape":"LayerInaccessibleException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

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.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" }, "GetRepositoryPolicy":{ "name":"GetRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRepositoryPolicyRequest"}, "output":{"shape":"GetRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryPolicyNotFoundException"} ], "documentation":"

Retrieves the repository policy for a specified repository.

" }, "InitiateLayerUpload":{ "name":"InitiateLayerUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InitiateLayerUploadRequest"}, "output":{"shape":"InitiateLayerUploadResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

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

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" }, "ListImages":{ "name":"ListImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListImagesRequest"}, "output":{"shape":"ListImagesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. 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.

" }, "PutImage":{ "name":"PutImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutImageRequest"}, "output":{"shape":"PutImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"ImageAlreadyExistsException"}, {"shape":"LayersNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates or updates the image manifest associated with an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" }, "SetRepositoryPolicy":{ "name":"SetRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetRepositoryPolicyRequest"}, "output":{"shape":"SetRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Applies a repository policy on a specified repository to control access permissions.

" }, "UploadLayerPart":{ "name":"UploadLayerPart", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UploadLayerPartRequest"}, "output":{"shape":"UploadLayerPartResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidLayerPartException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"UploadNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

" } }, "shapes":{ "Arn":{"type":"string"}, "AuthorizationData":{ "type":"structure", "members":{ "authorizationToken":{ "shape":"Base64", "documentation":"

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.

" }, "expiresAt":{ "shape":"ExpirationTimestamp", "documentation":"

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

" }, "proxyEndpoint":{ "shape":"ProxyEndpoint", "documentation":"

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

" } }, "documentation":"

An object representing authorization data for an Amazon ECR registry.

" }, "AuthorizationDataList":{ "type":"list", "member":{"shape":"AuthorizationData"} }, "Base64":{ "type":"string", "pattern":"^\\S+$" }, "BatchCheckLayerAvailabilityRequest":{ "type":"structure", "required":[ "repositoryName", "layerDigests" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "layerDigests":{ "shape":"BatchedOperationLayerDigestList", "documentation":"

The digests of the image layers to check.

" } } }, "BatchCheckLayerAvailabilityResponse":{ "type":"structure", "members":{ "layers":{ "shape":"LayerList", "documentation":"

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

" }, "failures":{ "shape":"LayerFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchDeleteImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageIds" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository that contains the image to delete.

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

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

" } }, "documentation":"

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

" }, "BatchDeleteImageResponse":{ "type":"structure", "members":{ "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The image IDs of the deleted images.

" }, "failures":{ "shape":"ImageFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchGetImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageIds" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository that contains the images to describe.

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

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

" } } }, "BatchGetImageResponse":{ "type":"structure", "members":{ "images":{ "shape":"ImageList", "documentation":"

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

" }, "failures":{ "shape":"ImageFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchedOperationLayerDigest":{ "type":"string", "max":1000, "min":0 }, "BatchedOperationLayerDigestList":{ "type":"list", "member":{"shape":"BatchedOperationLayerDigest"}, "max":100, "min":1 }, "CompleteLayerUploadRequest":{ "type":"structure", "required":[ "repositoryName", "uploadId", "layerDigests" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "uploadId":{ "shape":"UploadId", "documentation":"

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

" }, "layerDigests":{ "shape":"LayerDigestList", "documentation":"

The sha256 digest of the image layer.

" } } }, "CompleteLayerUploadResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the layer.

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The sha256 digest of the image layer.

" } } }, "CreateRepositoryRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" } } }, "CreateRepositoryResponse":{ "type":"structure", "members":{ "repository":{ "shape":"Repository", "documentation":"

The repository that was created.

" } } }, "CreationTimestamp":{"type":"timestamp"}, "DeleteRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" } } }, "DeleteRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy that was deleted from the repository.

" } } }, "DeleteRepositoryRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to delete.

" }, "force":{ "shape":"ForceFlag", "documentation":"

Force the deletion of the repository if it contains images.

" } } }, "DeleteRepositoryResponse":{ "type":"structure", "members":{ "repository":{ "shape":"Repository", "documentation":"

The repository that was deleted.

" } } }, "DescribeImagesFilter":{ "type":"structure", "members":{ "tagStatus":{ "shape":"TagStatus", "documentation":"

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

" } }, "documentation":"

An object representing a filter on a DescribeImages operation.

" }, "DescribeImagesRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The list of image IDs for the requested repository.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

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 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.

" }, "filter":{ "shape":"DescribeImagesFilter", "documentation":"

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

" } } }, "DescribeImagesResponse":{ "type":"structure", "members":{ "imageDetails":{ "shape":"ImageDetailList", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "DescribeRepositoriesRequest":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryNames":{ "shape":"RepositoryNameList", "documentation":"

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

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable.

" } } }, "DescribeRepositoriesResponse":{ "type":"structure", "members":{ "repositories":{ "shape":"RepositoryList", "documentation":"

A list of repository objects corresponding to valid repositories.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "EmptyUploadException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layer upload does not contain any layer parts.

", "exception":true }, "ExceptionMessage":{"type":"string"}, "ExpirationTimestamp":{"type":"timestamp"}, "ForceFlag":{"type":"boolean"}, "GetAuthorizationTokenRegistryIdList":{ "type":"list", "member":{"shape":"RegistryId"}, "max":10, "min":1 }, "GetAuthorizationTokenRequest":{ "type":"structure", "members":{ "registryIds":{ "shape":"GetAuthorizationTokenRegistryIdList", "documentation":"

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

" } } }, "GetAuthorizationTokenResponse":{ "type":"structure", "members":{ "authorizationData":{ "shape":"AuthorizationDataList", "documentation":"

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

" } } }, "GetDownloadUrlForLayerRequest":{ "type":"structure", "required":[ "repositoryName", "layerDigest" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The digest of the image layer to download.

" } } }, "GetDownloadUrlForLayerResponse":{ "type":"structure", "members":{ "downloadUrl":{ "shape":"Url", "documentation":"

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

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The digest of the image layer to download.

" } } }, "GetRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository whose policy you want to retrieve.

" } } }, "GetRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text associated with the repository.

" } } }, "Image":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository associated with the image.

" }, "imageId":{ "shape":"ImageIdentifier", "documentation":"

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

" }, "imageManifest":{ "shape":"ImageManifest", "documentation":"

The image manifest associated with the image.

" } }, "documentation":"

An object representing an Amazon ECR image.

" }, "ImageAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified image has already been pushed, and there are no changes to the manifest or image tag since the last push.

", "exception":true }, "ImageDetail":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry to which this image belongs.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to which this image belongs.

" }, "imageDigest":{ "shape":"ImageDigest", "documentation":"

The sha256 digest of the image manifest.

" }, "imageTags":{ "shape":"ImageTagList", "documentation":"

The list of tags associated with this image.

" }, "imageSizeInBytes":{ "shape":"ImageSizeInBytes", "documentation":"

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.

" }, "imagePushedAt":{ "shape":"PushTimestamp", "documentation":"

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

" } }, "documentation":"

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

" }, "ImageDetailList":{ "type":"list", "member":{"shape":"ImageDetail"} }, "ImageDigest":{"type":"string"}, "ImageFailure":{ "type":"structure", "members":{ "imageId":{ "shape":"ImageIdentifier", "documentation":"

The image ID associated with the failure.

" }, "failureCode":{ "shape":"ImageFailureCode", "documentation":"

The code associated with the failure.

" }, "failureReason":{ "shape":"ImageFailureReason", "documentation":"

The reason for the failure.

" } }, "documentation":"

An object representing an Amazon ECR image failure.

" }, "ImageFailureCode":{ "type":"string", "enum":[ "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag" ] }, "ImageFailureList":{ "type":"list", "member":{"shape":"ImageFailure"} }, "ImageFailureReason":{"type":"string"}, "ImageIdentifier":{ "type":"structure", "members":{ "imageDigest":{ "shape":"ImageDigest", "documentation":"

The sha256 digest of the image manifest.

" }, "imageTag":{ "shape":"ImageTag", "documentation":"

The tag used for the image.

" } }, "documentation":"

An object with identifying information for an Amazon ECR image.

" }, "ImageIdentifierList":{ "type":"list", "member":{"shape":"ImageIdentifier"}, "max":100, "min":1 }, "ImageList":{ "type":"list", "member":{"shape":"Image"} }, "ImageManifest":{"type":"string"}, "ImageNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The image requested does not exist in the specified repository.

", "exception":true }, "ImageSizeInBytes":{"type":"long"}, "ImageTag":{"type":"string"}, "ImageTagList":{ "type":"list", "member":{"shape":"ImageTag"} }, "InitiateLayerUploadRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" } } }, "InitiateLayerUploadResponse":{ "type":"structure", "members":{ "uploadId":{ "shape":"UploadId", "documentation":"

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

" }, "partSize":{ "shape":"PartSize", "documentation":"

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

" } } }, "InvalidLayerException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

", "exception":true }, "InvalidLayerPartException":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the exception.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the exception.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the exception.

" }, "lastValidByteReceived":{ "shape":"PartSize", "documentation":"

The last valid byte received from the layer part upload that is associated with the exception.

" }, "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", "exception":true }, "Layer":{ "type":"structure", "members":{ "layerDigest":{ "shape":"LayerDigest", "documentation":"

The sha256 digest of the image layer.

" }, "layerAvailability":{ "shape":"LayerAvailability", "documentation":"

The availability status of the image layer. Valid values are AVAILABLE and UNAVAILABLE.

" }, "layerSize":{ "shape":"LayerSizeInBytes", "documentation":"

The size, in bytes, of the image layer.

" } }, "documentation":"

An object representing an Amazon ECR image layer.

" }, "LayerAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The image layer already exists in the associated repository.

", "exception":true }, "LayerAvailability":{ "type":"string", "enum":[ "AVAILABLE", "UNAVAILABLE" ] }, "LayerDigest":{ "type":"string", "pattern":"[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+" }, "LayerDigestList":{ "type":"list", "member":{"shape":"LayerDigest"}, "max":100, "min":1 }, "LayerFailure":{ "type":"structure", "members":{ "layerDigest":{ "shape":"BatchedOperationLayerDigest", "documentation":"

The layer digest associated with the failure.

" }, "failureCode":{ "shape":"LayerFailureCode", "documentation":"

The failure code associated with the failure.

" }, "failureReason":{ "shape":"LayerFailureReason", "documentation":"

The reason for the failure.

" } }, "documentation":"

An object representing an Amazon ECR image layer failure.

" }, "LayerFailureCode":{ "type":"string", "enum":[ "InvalidLayerDigest", "MissingLayerDigest" ] }, "LayerFailureList":{ "type":"list", "member":{"shape":"LayerFailure"} }, "LayerFailureReason":{"type":"string"}, "LayerInaccessibleException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

", "exception":true }, "LayerList":{ "type":"list", "member":{"shape":"Layer"} }, "LayerPartBlob":{"type":"blob"}, "LayerPartTooSmallException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

Layer parts must be at least 5 MiB in size.

", "exception":true }, "LayerSizeInBytes":{"type":"long"}, "LayersNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layers could not be found, or the specified layer is not valid for this repository.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon EC2 Container Registry User Guide.

", "exception":true }, "ListImagesFilter":{ "type":"structure", "members":{ "tagStatus":{ "shape":"TagStatus", "documentation":"

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

" } }, "documentation":"

An object representing a filter on a ListImages operation.

" }, "ListImagesRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository whose image IDs are to be listed.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

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 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

" }, "filter":{ "shape":"ListImagesFilter", "documentation":"

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

" } } }, "ListImagesResponse":{ "type":"structure", "members":{ "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The list of image IDs for the requested repository.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

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.

" } } }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "NextToken":{"type":"string"}, "PartSize":{ "type":"long", "min":0 }, "ProxyEndpoint":{"type":"string"}, "PushTimestamp":{"type":"timestamp"}, "PutImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageManifest" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "imageManifest":{ "shape":"ImageManifest", "documentation":"

The image manifest corresponding to the image to be uploaded.

" } } }, "PutImageResponse":{ "type":"structure", "members":{ "image":{ "shape":"Image", "documentation":"

Details of the image uploaded.

" } } }, "RegistryId":{ "type":"string", "pattern":"[0-9]{12}" }, "Repository":{ "type":"structure", "members":{ "repositoryArn":{ "shape":"Arn", "documentation":"

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

" }, "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository.

" }, "repositoryUri":{ "shape":"Url", "documentation":"

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

" }, "createdAt":{ "shape":"CreationTimestamp", "documentation":"

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

" } }, "documentation":"

An object representing a repository.

" }, "RepositoryAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository already exists in the specified registry.

", "exception":true }, "RepositoryList":{ "type":"list", "member":{"shape":"Repository"} }, "RepositoryName":{ "type":"string", "max":256, "min":2, "pattern":"(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*" }, "RepositoryNameList":{ "type":"list", "member":{"shape":"RepositoryName"}, "max":100, "min":1 }, "RepositoryNotEmptyException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

", "exception":true }, "RepositoryNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

", "exception":true }, "RepositoryPolicyNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository and registry combination does not have an associated repository policy.

", "exception":true }, "RepositoryPolicyText":{ "type":"string", "max":10240, "min":0 }, "ServerException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

These errors are usually caused by a server-side issue.

", "exception":true, "fault":true }, "SetRepositoryPolicyRequest":{ "type":"structure", "required":[ "repositoryName", "policyText" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to receive the policy.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text to apply to the repository.

" }, "force":{ "shape":"ForceFlag", "documentation":"

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.

" } } }, "SetRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text applied to the repository.

" } } }, "TagStatus":{ "type":"string", "enum":[ "TAGGED", "UNTAGGED" ] }, "UploadId":{ "type":"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}" }, "UploadLayerPartRequest":{ "type":"structure", "required":[ "repositoryName", "uploadId", "partFirstByte", "partLastByte", "layerPartBlob" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

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

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

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

" }, "uploadId":{ "shape":"UploadId", "documentation":"

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

" }, "partFirstByte":{ "shape":"PartSize", "documentation":"

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

" }, "partLastByte":{ "shape":"PartSize", "documentation":"

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

" }, "layerPartBlob":{ "shape":"LayerPartBlob", "documentation":"

The base64-encoded layer part payload.

" } } }, "UploadLayerPartResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the request.

" }, "lastByteReceived":{ "shape":"PartSize", "documentation":"

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

" } } }, "UploadNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The upload could not be found, or the specified upload id is not valid for this repository.

", "exception":true }, "Url":{"type":"string"} }, "documentation":"

Amazon EC2 Container Registry (Amazon ECR) is a managed AWS 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 AWS 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.

" }