{ "version": "2.0", "metadata": { "apiVersion": "2015-09-21", "endpointPrefix": "api.ecr", "jsonVersion": "1.1", "protocol": "json", "serviceAbbreviation": "Amazon ECR", "serviceFullName": "Amazon EC2 Container Registry", "serviceId": "ECR", "signatureVersion": "v4", "signingName": "ecr", "targetPrefix": "AmazonEC2ContainerRegistry_V20150921", "uid": "ecr-2015-09-21" }, "operations": { "BatchCheckLayerAvailability": { "name": "BatchCheckLayerAvailability", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "BatchCheckLayerAvailabilityRequest" }, "output": { "shape": "BatchCheckLayerAvailabilityResponse" }, "errors": [ { "shape": "RepositoryNotFoundException" }, { "shape": "InvalidParameterException" }, { "shape": "ServerException" } ], "documentation": "
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 has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
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.
" }, "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 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.
" }, "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": "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.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
" }, "DeleteLifecyclePolicy": { "name": "DeleteLifecyclePolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DeleteLifecyclePolicyRequest" }, "output": { "shape": "DeleteLifecyclePolicyResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "LifecyclePolicyNotFoundException" } ], "documentation": "Deletes the lifecycle policy associated with the specified 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 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.
Deletes the repository policy associated with the specified repository.
" }, "DescribeImageScanFindings": { "name": "DescribeImageScanFindings", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "DescribeImageScanFindingsRequest" }, "output": { "shape": "DescribeImageScanFindingsResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "ImageNotFoundException" }, { "shape": "ScanNotFoundException" } ], "documentation": "Returns the scan findings for the specified image.
" }, "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.
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.
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 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.
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 that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Retrieves the lifecycle policy for the specified repository.
" }, "GetLifecyclePolicyPreview": { "name": "GetLifecyclePolicyPreview", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "GetLifecyclePolicyPreviewRequest" }, "output": { "shape": "GetLifecyclePolicyPreviewResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "LifecyclePolicyPreviewNotFoundException" } ], "documentation": "Retrieves the results of the lifecycle policy preview request for the specified repository.
" }, "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 the specified repository.
" }, "InitiateLayerUpload": { "name": "InitiateLayerUpload", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InitiateLayerUploadRequest" }, "output": { "shape": "InitiateLayerUploadResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" } ], "documentation": "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 or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
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.
List the tags for an Amazon ECR resource.
" }, "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": "ReferencedImagesNotFoundException" }, { "shape": "LimitExceededException" }, { "shape": "ImageTagAlreadyExistsException" } ], "documentation": "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 the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Updates the image scanning configuration for the specified repository.
" }, "PutImageTagMutability": { "name": "PutImageTagMutability", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutImageTagMutabilityRequest" }, "output": { "shape": "PutImageTagMutabilityResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" } ], "documentation": "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.
" }, "PutLifecyclePolicy": { "name": "PutLifecyclePolicy", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "PutLifecyclePolicyRequest" }, "output": { "shape": "PutLifecyclePolicyResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" } ], "documentation": "Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
" }, "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 to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
" }, "StartImageScan": { "name": "StartImageScan", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartImageScanRequest" }, "output": { "shape": "StartImageScanResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "UnsupportedImageTypeException" }, { "shape": "LimitExceededException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "ImageNotFoundException" } ], "documentation": "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.
" }, "StartLifecyclePolicyPreview": { "name": "StartLifecyclePolicyPreview", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "StartLifecyclePolicyPreviewRequest" }, "output": { "shape": "StartLifecyclePolicyPreviewResponse" }, "errors": [ { "shape": "ServerException" }, { "shape": "InvalidParameterException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "LifecyclePolicyNotFoundException" }, { "shape": "LifecyclePolicyPreviewInProgressException" } ], "documentation": "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.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InvalidTagParameterException" }, { "shape": "TooManyTagsException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "ServerException" } ], "documentation": "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.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "InvalidParameterException" }, { "shape": "InvalidTagParameterException" }, { "shape": "TooManyTagsException" }, { "shape": "RepositoryNotFoundException" }, { "shape": "ServerException" } ], "documentation": "Deletes specified tags from a resource.
" }, "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.
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.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
The attribute key.
" }, "value": { "shape": "AttributeValue", "documentation": "The value assigned to the attribute key.
" } }, "documentation": "This data type is used in the ImageScanFinding data type.
" }, "AttributeKey": { "type": "string", "max": 128, "min": 1 }, "AttributeList": { "type": "list", "member": { "shape": "Attribute" }, "max": 50, "min": 0 }, "AttributeValue": { "type": "string", "max": 256, "min": 1 }, "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
.
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
..
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
.
Deletes specified images within a specified repository. Images are specified with either the imageTag
or imageDigest
.
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
.
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
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.
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.
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
).
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.
" }, "imageTagMutability": { "shape": "ImageTagMutability", "documentation": "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.
The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
" } } }, "CreateRepositoryResponse": { "type": "structure", "members": { "repository": { "shape": "Repository", "documentation": "The repository that was created.
" } } }, "CreationTimestamp": { "type": "timestamp" }, "DeleteLifecyclePolicyRequest": { "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.
" } } }, "DeleteLifecyclePolicyResponse": { "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON lifecycle policy text.
" }, "lastEvaluatedAt": { "shape": "EvaluationTimestamp", "documentation": "The time stamp of the last time that the lifecycle policy was run.
" } } }, "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": "If a repository contains images, forces the deletion.
" } } }, "DeleteRepositoryResponse": { "type": "structure", "members": { "repository": { "shape": "Repository", "documentation": "The repository that was deleted.
" } } }, "DescribeImageScanFindingsRequest": { "type": "structure", "required": [ "repositoryName", "imageId" ], "members": { "registryId": { "shape": "RegistryId", "documentation": "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.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The repository for the image for which to describe the scan findings.
" }, "imageId": { "shape": "ImageIdentifier" }, "nextToken": { "shape": "NextToken", "documentation": "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.
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.
The registry ID associated with the request.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The repository name associated with the request.
" }, "imageId": { "shape": "ImageIdentifier" }, "imageScanStatus": { "shape": "ImageScanStatus", "documentation": "The current state of the scan.
" }, "imageScanFindings": { "shape": "ImageScanFindings", "documentation": "The information contained in the image scan findings.
" }, "nextToken": { "shape": "NextToken", "documentation": "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.
The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
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 describe images. 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": "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. This option cannot be used when you specify images with imageIds
.
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
.
The filter key and value with which to filter your DescribeImages
results.
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.
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 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.
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
.
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.
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.
" } } }, "GetAuthorizationTokenResponse": { "type": "structure", "members": { "authorizationData": { "shape": "AuthorizationDataList", "documentation": "A list of authorization token data objects that correspond to the registryIds
values in the request.
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.
" } } }, "GetLifecyclePolicyPreviewRequest": { "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.
" }, "imageIds": { "shape": "ImageIdentifierList", "documentation": "The list of imageIDs to be included.
" }, "nextToken": { "shape": "NextToken", "documentation": "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
.
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
.
An optional parameter that filters results based on image tag status and all tags, if tagged.
" } } }, "GetLifecyclePolicyPreviewResponse": { "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON lifecycle policy text.
" }, "status": { "shape": "LifecyclePolicyPreviewStatus", "documentation": "The status of the lifecycle policy preview request.
" }, "nextToken": { "shape": "NextToken", "documentation": "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.
The results of the lifecycle policy preview request.
" }, "summary": { "shape": "LifecyclePolicyPreviewSummary", "documentation": "The list of images that is returned as a result of the action.
" } } }, "GetLifecyclePolicyRequest": { "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.
" } } }, "GetLifecyclePolicyResponse": { "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON lifecycle policy text.
" }, "lastEvaluatedAt": { "shape": "EvaluationTimestamp", "documentation": "The time stamp of the last time that the lifecycle policy was run.
" } } }, "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 with the policy 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.
" }, "imageManifestMediaType": { "shape": "MediaType", "documentation": "The media type associated with the image manifest.
" } }, "documentation": "An object representing an Amazon ECR image.
" }, "ImageActionType": { "type": "string", "enum": [ "EXPIRE" ] }, "ImageCount": { "type": "integer", "min": 0 }, "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.
The list of tags associated with this image.
" }, "imageSizeInBytes": { "shape": "ImageSizeInBytes", "documentation": "The size, in bytes, of the image in the repository.
If the image is a manifest list, this will be the max size of all manifests in the list.
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.
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
" }, "imageScanStatus": { "shape": "ImageScanStatus", "documentation": "The current state of the scan.
" }, "imageScanFindingsSummary": { "shape": "ImageScanFindingsSummary", "documentation": "A summary of the last completed image scan.
" } }, "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", "ImageReferencedByManifestList" ] }, "ImageFailureList": { "type": "list", "member": { "shape": "ImageFailure" } }, "ImageFailureReason": { "type": "string" }, "ImageIdentifier": { "type": "structure", "members": { "imageDigest": { "shape": "ImageDigest", "documentation": "The sha256
digest of the image manifest.
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", "max": 4194304, "min": 1 }, "ImageScanFinding": { "type": "structure", "members": { "name": { "shape": "FindingName", "documentation": "The name associated with the finding, usually a CVE number.
" }, "description": { "shape": "FindingDescription", "documentation": "The description of the finding.
" }, "uri": { "shape": "Url", "documentation": "A link containing additional details about the security vulnerability.
" }, "severity": { "shape": "FindingSeverity", "documentation": "The finding severity.
" }, "attributes": { "shape": "AttributeList", "documentation": "A collection of attributes of the host from which the finding is generated.
" } }, "documentation": "Contains information about an image scan finding.
" }, "ImageScanFindingList": { "type": "list", "member": { "shape": "ImageScanFinding" } }, "ImageScanFindings": { "type": "structure", "members": { "imageScanCompletedAt": { "shape": "ScanTimestamp", "documentation": "The time of the last completed image scan.
" }, "vulnerabilitySourceUpdatedAt": { "shape": "VulnerabilitySourceUpdateTimestamp", "documentation": "The time when the vulnerability data was last scanned.
" }, "findings": { "shape": "ImageScanFindingList", "documentation": "The findings from the image scan.
" }, "findingSeverityCounts": { "shape": "FindingSeverityCounts", "documentation": "The image vulnerability counts, sorted by severity.
" } }, "documentation": "The details of an image scan.
" }, "ImageScanFindingsSummary": { "type": "structure", "members": { "imageScanCompletedAt": { "shape": "ScanTimestamp", "documentation": "The time of the last completed image scan.
" }, "vulnerabilitySourceUpdatedAt": { "shape": "VulnerabilitySourceUpdateTimestamp", "documentation": "The time when the vulnerability data was last scanned.
" }, "findingSeverityCounts": { "shape": "FindingSeverityCounts", "documentation": "The image vulnerability counts, sorted by severity.
" } }, "documentation": "A summary of the last completed image scan.
" }, "ImageScanStatus": { "type": "structure", "members": { "status": { "shape": "ScanStatus", "documentation": "The current state of an image scan.
" }, "description": { "shape": "ScanStatusDescription", "documentation": "The description of the image scan status.
" } }, "documentation": "The current status of an image scan.
" }, "ImageScanningConfiguration": { "type": "structure", "members": { "scanOnPush": { "shape": "ScanOnPushFlag", "documentation": "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.
The image scanning configuration for a repository.
" }, "ImageSizeInBytes": { "type": "long" }, "ImageTag": { "type": "string", "max": 300, "min": 1 }, "ImageTagList": { "type": "list", "member": { "shape": "ImageTag" } }, "ImageTagMutability": { "type": "string", "enum": [ "MUTABLE", "IMMUTABLE" ] }, "InitiateLayerUploadRequest": { "type": "structure", "required": [ "repositoryName" ], "members": { "registryId": { "shape": "RegistryId", "documentation": "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.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The name of the repository to which you intend to upload layers.
" } } }, "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.
" } } }, "Layer": { "type": "structure", "members": { "layerDigest": { "shape": "LayerDigest", "documentation": "The sha256
digest of the image layer.
The availability status of the image layer.
" }, "layerSize": { "shape": "LayerSizeInBytes", "documentation": "The size, in bytes, of the image layer.
" }, "mediaType": { "shape": "MediaType", "documentation": "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
.
An object representing an Amazon ECR image layer.
" }, "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" }, "LayerList": { "type": "list", "member": { "shape": "Layer" } }, "LayerPartBlob": { "type": "blob", "max": 20971520, "min": 0 }, "LayerSizeInBytes": { "type": "long" }, "LifecyclePolicyPreviewFilter": { "type": "structure", "members": { "tagStatus": { "shape": "TagStatus", "documentation": "The tag status of the image.
" } }, "documentation": "The filter for the lifecycle policy preview.
" }, "LifecyclePolicyPreviewResult": { "type": "structure", "members": { "imageTags": { "shape": "ImageTagList", "documentation": "The list of tags associated with this image.
" }, "imageDigest": { "shape": "ImageDigest", "documentation": "The sha256
digest of the image manifest.
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
" }, "action": { "shape": "LifecyclePolicyRuleAction", "documentation": "The type of action to be taken.
" }, "appliedRulePriority": { "shape": "LifecyclePolicyRulePriority", "documentation": "The priority of the applied rule.
" } }, "documentation": "The result of the lifecycle policy preview.
" }, "LifecyclePolicyPreviewResultList": { "type": "list", "member": { "shape": "LifecyclePolicyPreviewResult" } }, "LifecyclePolicyPreviewStatus": { "type": "string", "enum": [ "IN_PROGRESS", "COMPLETE", "EXPIRED", "FAILED" ] }, "LifecyclePolicyPreviewSummary": { "type": "structure", "members": { "expiringImageTotalCount": { "shape": "ImageCount", "documentation": "The number of expiring images.
" } }, "documentation": "The summary of the lifecycle policy preview request.
" }, "LifecyclePolicyRuleAction": { "type": "structure", "members": { "type": { "shape": "ImageActionType", "documentation": "The type of action to be taken.
" } }, "documentation": "The type of action to be taken.
" }, "LifecyclePolicyRulePriority": { "type": "integer", "min": 1 }, "LifecyclePolicyText": { "type": "string", "max": 30720, "min": 100 }, "LifecyclePreviewMaxResults": { "type": "integer", "max": 100, "min": 1 }, "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
.
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 in which to list images. If you do not specify a registry, the default registry is assumed.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The repository with image IDs 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.
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.
The filter key and value with which to filter your ListImages
results.
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.
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.
" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "shape": "TagList", "documentation": "The tags for the resource.
" } } }, "MaxResults": { "type": "integer", "max": 1000, "min": 1 }, "MediaType": { "type": "string" }, "MediaTypeList": { "type": "list", "member": { "shape": "MediaType" }, "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.
" }, "imageManifestMediaType": { "shape": "MediaType", "documentation": "The media type of the image manifest. If you push an image manifest that does not contain the mediaType
field, you must specify the imageManifestMediaType
in the request.
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.
" } } }, "PutImageResponse": { "type": "structure", "members": { "image": { "shape": "Image", "documentation": "Details of the image uploaded.
" } } }, "PutImageScanningConfigurationRequest": { "type": "structure", "required": [ "repositoryName", "imageScanningConfiguration" ], "members": { "registryId": { "shape": "RegistryId", "documentation": "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.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The name of the repository in which to update the image scanning configuration setting.
" }, "imageScanningConfiguration": { "shape": "ImageScanningConfiguration", "documentation": "The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
" } } }, "PutImageScanningConfigurationResponse": { "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.
" }, "imageScanningConfiguration": { "shape": "ImageScanningConfiguration", "documentation": "The image scanning configuration setting for the repository.
" } } }, "PutImageTagMutabilityRequest": { "type": "structure", "required": [ "repositoryName", "imageTagMutability" ], "members": { "registryId": { "shape": "RegistryId", "documentation": "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.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The name of the repository in which to update the image tag mutability settings.
" }, "imageTagMutability": { "shape": "ImageTagMutability", "documentation": "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.
The registry ID associated with the request.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The repository name associated with the request.
" }, "imageTagMutability": { "shape": "ImageTagMutability", "documentation": "The image tag mutability setting for the repository.
" } } }, "PutLifecyclePolicyRequest": { "type": "structure", "required": [ "repositoryName", "lifecyclePolicyText" ], "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON repository policy text to apply to the repository.
" } } }, "PutLifecyclePolicyResponse": { "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON repository policy text.
" } } }, "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, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test
.
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
or pull
operations.
The date and time, in JavaScript date format, when the repository was created.
" }, "imageTagMutability": { "shape": "ImageTagMutability", "documentation": "The tag mutability setting for the repository.
" }, "imageScanningConfiguration": { "shape": "ImageScanningConfiguration" } }, "documentation": "An object representing a repository.
" }, "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 }, "RepositoryPolicyText": { "type": "string", "max": 10240, "min": 0 }, "ScanOnPushFlag": { "type": "boolean" }, "ScanStatus": { "type": "string", "enum": [ "IN_PROGRESS", "COMPLETE", "FAILED" ] }, "ScanStatusDescription": { "type": "string" }, "ScanTimestamp": { "type": "timestamp" }, "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. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
" }, "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.
" } } }, "SeverityCount": { "type": "integer", "min": 0 }, "StartImageScanRequest": { "type": "structure", "required": [ "repositoryName", "imageId" ], "members": { "registryId": { "shape": "RegistryId", "documentation": "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.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The name of the repository that contains the images to scan.
" }, "imageId": { "shape": "ImageIdentifier" } } }, "StartImageScanResponse": { "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.
" }, "imageId": { "shape": "ImageIdentifier" }, "imageScanStatus": { "shape": "ImageScanStatus", "documentation": "The current state of the scan.
" } } }, "StartLifecyclePolicyPreviewRequest": { "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 to be evaluated.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
" } } }, "StartLifecyclePolicyPreviewResponse": { "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.
" }, "lifecyclePolicyText": { "shape": "LifecyclePolicyText", "documentation": "The JSON repository policy text.
" }, "status": { "shape": "LifecyclePolicyPreviewStatus", "documentation": "The status of the lifecycle policy preview request.
" } } }, "Tag": { "type": "structure", "members": { "Key": { "shape": "TagKey", "documentation": "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.
The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
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.
" }, "TagKey": { "type": "string" }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" } }, "TagList": { "type": "list", "member": { "shape": "Tag" } }, "TagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tags" ], "members": { "resourceArn": { "shape": "Arn", "documentation": "The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
" }, "tags": { "shape": "TagList", "documentation": "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.
" } } }, "TagResourceResponse": { "type": "structure", "members": {} }, "TagStatus": { "type": "string", "enum": [ "TAGGED", "UNTAGGED", "ANY" ] }, "TagValue": { "type": "string" }, "UntagResourceRequest": { "type": "structure", "required": [ "resourceArn", "tagKeys" ], "members": { "resourceArn": { "shape": "Arn", "documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
" }, "tagKeys": { "shape": "TagKeyList", "documentation": "The keys of the tags to be removed.
" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "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 to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.
" }, "repositoryName": { "shape": "RepositoryName", "documentation": "The name of the repository to which you are uploading layer parts.
" }, "uploadId": { "shape": "UploadId", "documentation": "The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
" }, "partFirstByte": { "shape": "PartSize", "documentation": "The position of the first byte of the layer part witin the overall image layer.
" }, "partLastByte": { "shape": "PartSize", "documentation": "The position of the last byte of the layer part within the overall image layer.
" }, "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.
" } } }, "Url": { "type": "string" }, "VulnerabilitySourceUpdateTimestamp": { "type": "timestamp" } }, "documentation": "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.
" }