3801 lines
153 KiB
JSON
3801 lines
153 KiB
JSON
{
|
|
"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":"<p>Checks the availability of one or more image layers in a repository.</p> <p>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.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
},
|
|
"BatchDeleteImage":{
|
|
"name":"BatchDeleteImage",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"BatchDeleteImageRequest"},
|
|
"output":{"shape":"BatchDeleteImageResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Deletes a list of specified images within a repository. Images are specified with either an <code>imageTag</code> or <code>imageDigest</code>.</p> <p>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.</p> <p>You can completely delete an image (and all of its tags) by specifying the image's digest in your request.</p>"
|
|
},
|
|
"BatchGetImage":{
|
|
"name":"BatchGetImage",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"BatchGetImageRequest"},
|
|
"output":{"shape":"BatchGetImageResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Gets detailed information for an image. Images are specified with either an <code>imageTag</code> or <code>imageDigest</code>.</p> <p>When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.</p>"
|
|
},
|
|
"BatchGetRepositoryScanningConfiguration":{
|
|
"name":"BatchGetRepositoryScanningConfiguration",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"BatchGetRepositoryScanningConfigurationRequest"},
|
|
"output":{"shape":"BatchGetRepositoryScanningConfigurationResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Gets the scanning configuration for one or more repositories.</p>"
|
|
},
|
|
"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"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a <code>sha256</code> digest of the image layer for data validation purposes.</p> <p>When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
},
|
|
"CreatePullThroughCacheRule":{
|
|
"name":"CreatePullThroughCacheRule",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CreatePullThroughCacheRuleRequest"},
|
|
"output":{"shape":"CreatePullThroughCacheRuleResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"PullThroughCacheRuleAlreadyExistsException"},
|
|
{"shape":"UnsupportedUpstreamRegistryException"},
|
|
{"shape":"LimitExceededException"}
|
|
],
|
|
"documentation":"<p>Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.</p>"
|
|
},
|
|
"CreateRepository":{
|
|
"name":"CreateRepository",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"CreateRepositoryRequest"},
|
|
"output":{"shape":"CreateRepositoryResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"InvalidTagParameterException"},
|
|
{"shape":"TooManyTagsException"},
|
|
{"shape":"RepositoryAlreadyExistsException"},
|
|
{"shape":"LimitExceededException"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Creates a repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Repositories.html\">Amazon ECR repositories</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"DeleteLifecyclePolicy":{
|
|
"name":"DeleteLifecyclePolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteLifecyclePolicyRequest"},
|
|
"output":{"shape":"DeleteLifecyclePolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"LifecyclePolicyNotFoundException"}
|
|
],
|
|
"documentation":"<p>Deletes the lifecycle policy associated with the specified repository.</p>"
|
|
},
|
|
"DeletePullThroughCacheRule":{
|
|
"name":"DeletePullThroughCacheRule",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeletePullThroughCacheRuleRequest"},
|
|
"output":{"shape":"DeletePullThroughCacheRuleResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"PullThroughCacheRuleNotFoundException"}
|
|
],
|
|
"documentation":"<p>Deletes a pull through cache rule.</p>"
|
|
},
|
|
"DeleteRegistryPolicy":{
|
|
"name":"DeleteRegistryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteRegistryPolicyRequest"},
|
|
"output":{"shape":"DeleteRegistryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RegistryPolicyNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Deletes the registry permissions policy.</p>"
|
|
},
|
|
"DeleteRepository":{
|
|
"name":"DeleteRepository",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteRepositoryRequest"},
|
|
"output":{"shape":"DeleteRepositoryResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"RepositoryNotEmptyException"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the <code>force</code> option to delete the repository.</p>"
|
|
},
|
|
"DeleteRepositoryPolicy":{
|
|
"name":"DeleteRepositoryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DeleteRepositoryPolicyRequest"},
|
|
"output":{"shape":"DeleteRepositoryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"RepositoryPolicyNotFoundException"}
|
|
],
|
|
"documentation":"<p>Deletes the repository policy associated with the specified repository.</p>"
|
|
},
|
|
"DescribeImageReplicationStatus":{
|
|
"name":"DescribeImageReplicationStatus",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeImageReplicationStatusRequest"},
|
|
"output":{"shape":"DescribeImageReplicationStatusResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ImageNotFoundException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Returns the replication status for a specified image.</p>"
|
|
},
|
|
"DescribeImageScanFindings":{
|
|
"name":"DescribeImageScanFindings",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeImageScanFindingsRequest"},
|
|
"output":{"shape":"DescribeImageScanFindingsResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ImageNotFoundException"},
|
|
{"shape":"ScanNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Returns the scan findings for the specified image.</p>"
|
|
},
|
|
"DescribeImages":{
|
|
"name":"DescribeImages",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeImagesRequest"},
|
|
"output":{"shape":"DescribeImagesResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ImageNotFoundException"}
|
|
],
|
|
"documentation":"<p>Returns metadata about the images in a repository.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
|
|
},
|
|
"DescribePullThroughCacheRules":{
|
|
"name":"DescribePullThroughCacheRules",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribePullThroughCacheRulesRequest"},
|
|
"output":{"shape":"DescribePullThroughCacheRulesResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"PullThroughCacheRuleNotFoundException"}
|
|
],
|
|
"documentation":"<p>Returns the pull through cache rules for a registry.</p>"
|
|
},
|
|
"DescribeRegistry":{
|
|
"name":"DescribeRegistry",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeRegistryRequest"},
|
|
"output":{"shape":"DescribeRegistryResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Describes the settings for a registry. The replication configuration for a repository can be created or updated with the <a>PutReplicationConfiguration</a> API action.</p>"
|
|
},
|
|
"DescribeRepositories":{
|
|
"name":"DescribeRepositories",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"DescribeRepositoriesRequest"},
|
|
"output":{"shape":"DescribeRepositoriesResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Describes image repositories in a registry.</p>"
|
|
},
|
|
"GetAuthorizationToken":{
|
|
"name":"GetAuthorizationToken",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetAuthorizationTokenRequest"},
|
|
"output":{"shape":"GetAuthorizationTokenResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"}
|
|
],
|
|
"documentation":"<p>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.</p> <p>The <code>authorizationToken</code> returned is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The CLI offers an <code>get-login-password</code> command that simplifies the login process. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth\">Registry authentication</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"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":"<p>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.</p> <p>When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
},
|
|
"GetLifecyclePolicy":{
|
|
"name":"GetLifecyclePolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetLifecyclePolicyRequest"},
|
|
"output":{"shape":"GetLifecyclePolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"LifecyclePolicyNotFoundException"}
|
|
],
|
|
"documentation":"<p>Retrieves the lifecycle policy for the specified repository.</p>"
|
|
},
|
|
"GetLifecyclePolicyPreview":{
|
|
"name":"GetLifecyclePolicyPreview",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetLifecyclePolicyPreviewRequest"},
|
|
"output":{"shape":"GetLifecyclePolicyPreviewResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"LifecyclePolicyPreviewNotFoundException"}
|
|
],
|
|
"documentation":"<p>Retrieves the results of the lifecycle policy preview request for the specified repository.</p>"
|
|
},
|
|
"GetRegistryPolicy":{
|
|
"name":"GetRegistryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetRegistryPolicyRequest"},
|
|
"output":{"shape":"GetRegistryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RegistryPolicyNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Retrieves the permissions policy for a registry.</p>"
|
|
},
|
|
"GetRegistryScanningConfiguration":{
|
|
"name":"GetRegistryScanningConfiguration",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetRegistryScanningConfigurationRequest"},
|
|
"output":{"shape":"GetRegistryScanningConfigurationResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Retrieves the scanning configuration for a registry.</p>"
|
|
},
|
|
"GetRepositoryPolicy":{
|
|
"name":"GetRepositoryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"GetRepositoryPolicyRequest"},
|
|
"output":{"shape":"GetRepositoryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"RepositoryPolicyNotFoundException"}
|
|
],
|
|
"documentation":"<p>Retrieves the repository policy for the specified repository.</p>"
|
|
},
|
|
"InitiateLayerUpload":{
|
|
"name":"InitiateLayerUpload",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"InitiateLayerUploadRequest"},
|
|
"output":{"shape":"InitiateLayerUploadResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Notifies Amazon ECR that you intend to upload an image layer.</p> <p>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.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
},
|
|
"ListImages":{
|
|
"name":"ListImages",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ListImagesRequest"},
|
|
"output":{"shape":"ListImagesResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Lists all the image IDs for the specified repository.</p> <p>You can filter images based on whether or not they are tagged by using the <code>tagStatus</code> filter and specifying either <code>TAGGED</code>, <code>UNTAGGED</code> or <code>ANY</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository.</p>"
|
|
},
|
|
"ListTagsForResource":{
|
|
"name":"ListTagsForResource",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"ListTagsForResourceRequest"},
|
|
"output":{"shape":"ListTagsForResourceResponse"},
|
|
"errors":[
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ServerException"}
|
|
],
|
|
"documentation":"<p>List the tags for an Amazon ECR resource.</p>"
|
|
},
|
|
"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"},
|
|
{"shape":"ImageDigestDoesNotMatchException"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Creates or updates the image manifest and tags associated with an image.</p> <p>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.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
},
|
|
"PutImageScanningConfiguration":{
|
|
"name":"PutImageScanningConfiguration",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutImageScanningConfigurationRequest"},
|
|
"output":{"shape":"PutImageScanningConfigurationResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<important> <p>The <code>PutImageScanningConfiguration</code> API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see <a>PutRegistryScanningConfiguration</a>.</p> </important> <p>Updates the image scanning configuration for the specified repository.</p>"
|
|
},
|
|
"PutImageTagMutability":{
|
|
"name":"PutImageTagMutability",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutImageTagMutabilityRequest"},
|
|
"output":{"shape":"PutImageTagMutabilityResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Updates the image tag mutability settings for the specified repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html\">Image tag mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"PutLifecyclePolicy":{
|
|
"name":"PutLifecyclePolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutLifecyclePolicyRequest"},
|
|
"output":{"shape":"PutLifecyclePolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Creates or updates the lifecycle policy for the specified repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html\">Lifecycle policy template</a>.</p>"
|
|
},
|
|
"PutRegistryPolicy":{
|
|
"name":"PutRegistryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutRegistryPolicyRequest"},
|
|
"output":{"shape":"PutRegistryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Creates or updates the permissions policy for your registry.</p> <p>A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html\">Registry permissions</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"PutRegistryScanningConfiguration":{
|
|
"name":"PutRegistryScanningConfiguration",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutRegistryScanningConfigurationRequest"},
|
|
"output":{"shape":"PutRegistryScanningConfigurationResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Creates or updates the scanning configuration for your private registry.</p>"
|
|
},
|
|
"PutReplicationConfiguration":{
|
|
"name":"PutReplicationConfiguration",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"PutReplicationConfigurationRequest"},
|
|
"output":{"shape":"PutReplicationConfigurationResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the <a>DescribeRegistry</a> API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECR</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p> <note> <p>When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see <a>PutRegistryPolicy</a>.</p> </note>"
|
|
},
|
|
"SetRepositoryPolicy":{
|
|
"name":"SetRepositoryPolicy",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/"
|
|
},
|
|
"input":{"shape":"SetRepositoryPolicyRequest"},
|
|
"output":{"shape":"SetRepositoryPolicyResponse"},
|
|
"errors":[
|
|
{"shape":"ServerException"},
|
|
{"shape":"InvalidParameterException"},
|
|
{"shape":"RepositoryNotFoundException"}
|
|
],
|
|
"documentation":"<p>Applies a repository policy to the specified repository to control access permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html\">Amazon ECR Repository policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"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"},
|
|
{"shape":"ValidationException"}
|
|
],
|
|
"documentation":"<p>Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html\">Image scanning</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"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":"<p>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.</p>"
|
|
},
|
|
"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":"<p>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.</p>"
|
|
},
|
|
"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":"<p>Deletes specified tags from a resource.</p>"
|
|
},
|
|
"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"},
|
|
{"shape":"KmsException"}
|
|
],
|
|
"documentation":"<p>Uploads an image layer part to Amazon ECR.</p> <p>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.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
|
|
}
|
|
},
|
|
"shapes":{
|
|
"Arch":{"type":"string"},
|
|
"Arn":{"type":"string"},
|
|
"Attribute":{
|
|
"type":"structure",
|
|
"required":["key"],
|
|
"members":{
|
|
"key":{
|
|
"shape":"AttributeKey",
|
|
"documentation":"<p>The attribute key.</p>"
|
|
},
|
|
"value":{
|
|
"shape":"AttributeValue",
|
|
"documentation":"<p>The value assigned to the attribute key.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>This data type is used in the <a>ImageScanFinding</a> data type.</p>"
|
|
},
|
|
"AttributeKey":{
|
|
"type":"string",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"AttributeList":{
|
|
"type":"list",
|
|
"member":{"shape":"Attribute"},
|
|
"max":50,
|
|
"min":0
|
|
},
|
|
"AttributeValue":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":1
|
|
},
|
|
"Author":{"type":"string"},
|
|
"AuthorizationData":{
|
|
"type":"structure",
|
|
"members":{
|
|
"authorizationToken":{
|
|
"shape":"Base64",
|
|
"documentation":"<p>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 <code>user:password</code> for private registry authentication using <code>docker login</code>.</p>"
|
|
},
|
|
"expiresAt":{
|
|
"shape":"ExpirationTimestamp",
|
|
"documentation":"<p>The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.</p>"
|
|
},
|
|
"proxyEndpoint":{
|
|
"shape":"ProxyEndpoint",
|
|
"documentation":"<p>The registry URL to use for this authorization token in a <code>docker login</code> command. The Amazon ECR registry URL format is <code>https://aws_account_id.dkr.ecr.region.amazonaws.com</code>. For example, <code>https://012345678910.dkr.ecr.us-east-1.amazonaws.com</code>.. </p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing authorization data for an Amazon ECR registry.</p>"
|
|
},
|
|
"AuthorizationDataList":{
|
|
"type":"list",
|
|
"member":{"shape":"AuthorizationData"}
|
|
},
|
|
"AwsEcrContainerImageDetails":{
|
|
"type":"structure",
|
|
"members":{
|
|
"architecture":{
|
|
"shape":"Arch",
|
|
"documentation":"<p>The architecture of the Amazon ECR container image.</p>"
|
|
},
|
|
"author":{
|
|
"shape":"Author",
|
|
"documentation":"<p>The image author of the Amazon ECR container image.</p>"
|
|
},
|
|
"imageHash":{
|
|
"shape":"ImageDigest",
|
|
"documentation":"<p>The image hash of the Amazon ECR container image.</p>"
|
|
},
|
|
"imageTags":{
|
|
"shape":"ImageTagsList",
|
|
"documentation":"<p>The image tags attached to the Amazon ECR container image.</p>"
|
|
},
|
|
"platform":{
|
|
"shape":"Platform",
|
|
"documentation":"<p>The platform of the Amazon ECR container image.</p>"
|
|
},
|
|
"pushedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time the Amazon ECR container image was pushed.</p>"
|
|
},
|
|
"registry":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry the Amazon ECR container image belongs to.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository the Amazon ECR container image resides in.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The image details of the Amazon ECR container image.</p>"
|
|
},
|
|
"Base64":{
|
|
"type":"string",
|
|
"pattern":"^\\S+$"
|
|
},
|
|
"BaseScore":{"type":"double"},
|
|
"BatchCheckLayerAvailabilityRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"layerDigests"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository that is associated with the image layers to check.</p>"
|
|
},
|
|
"layerDigests":{
|
|
"shape":"BatchedOperationLayerDigestList",
|
|
"documentation":"<p>The digests of the image layers to check.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchCheckLayerAvailabilityResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"layers":{
|
|
"shape":"LayerList",
|
|
"documentation":"<p>A list of image layer objects corresponding to the image layer references in the request.</p>"
|
|
},
|
|
"failures":{
|
|
"shape":"LayerFailureList",
|
|
"documentation":"<p>Any failures associated with the call.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchDeleteImageRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageIds"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository that contains the image to delete.</p>"
|
|
},
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>A list of image ID references that correspond to images to delete. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Deletes specified images within a specified repository. Images are specified with either the <code>imageTag</code> or <code>imageDigest</code>.</p>"
|
|
},
|
|
"BatchDeleteImageResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>The image IDs of the deleted images.</p>"
|
|
},
|
|
"failures":{
|
|
"shape":"ImageFailureList",
|
|
"documentation":"<p>Any failures associated with the call.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchGetImageRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageIds"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository that contains the images to describe.</p>"
|
|
},
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>A list of image ID references that correspond to images to describe. The format of the <code>imageIds</code> reference is <code>imageTag=tag</code> or <code>imageDigest=digest</code>.</p>"
|
|
},
|
|
"acceptedMediaTypes":{
|
|
"shape":"MediaTypeList",
|
|
"documentation":"<p>The accepted media types for the request.</p> <p>Valid values: <code>application/vnd.docker.distribution.manifest.v1+json</code> | <code>application/vnd.docker.distribution.manifest.v2+json</code> | <code>application/vnd.oci.image.manifest.v1+json</code> </p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchGetImageResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"images":{
|
|
"shape":"ImageList",
|
|
"documentation":"<p>A list of image objects corresponding to the image references in the request.</p>"
|
|
},
|
|
"failures":{
|
|
"shape":"ImageFailureList",
|
|
"documentation":"<p>Any failures associated with the call.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchGetRepositoryScanningConfigurationRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryNames"],
|
|
"members":{
|
|
"repositoryNames":{
|
|
"shape":"ScanningConfigurationRepositoryNameList",
|
|
"documentation":"<p>One or more repository names to get the scanning configuration for.</p>"
|
|
}
|
|
}
|
|
},
|
|
"BatchGetRepositoryScanningConfigurationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"scanningConfigurations":{
|
|
"shape":"RepositoryScanningConfigurationList",
|
|
"documentation":"<p>The scanning configuration for the requested repositories.</p>"
|
|
},
|
|
"failures":{
|
|
"shape":"RepositoryScanningConfigurationFailureList",
|
|
"documentation":"<p>Any failures associated with the call.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>The Amazon Web Services account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to associate with the image layer.</p>"
|
|
},
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the image layer.</p>"
|
|
},
|
|
"layerDigests":{
|
|
"shape":"LayerDigestList",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image layer.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CompleteLayerUploadResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID associated with the layer.</p>"
|
|
},
|
|
"layerDigest":{
|
|
"shape":"LayerDigest",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image layer.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreatePullThroughCacheRuleRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"ecrRepositoryPrefix",
|
|
"upstreamRegistryUrl"
|
|
],
|
|
"members":{
|
|
"ecrRepositoryPrefix":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefix",
|
|
"documentation":"<p>The repository name prefix to use when caching images from the source registry.</p>"
|
|
},
|
|
"upstreamRegistryUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The registry URL of the upstream public registry to use as the source for the pull through cache rule.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreatePullThroughCacheRuleResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ecrRepositoryPrefix":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefix",
|
|
"documentation":"<p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>"
|
|
},
|
|
"upstreamRegistryUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The upstream registry URL associated with the pull through cache rule.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"CreationTimestamp",
|
|
"documentation":"<p>The date and time, in JavaScript date format, when the pull through cache rule was created.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateRepositoryRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name to use for the repository. The repository name may be specified on its own (such as <code>nginx-web-app</code>) or it can be prepended with a namespace to group the repository into a category (such as <code>project-a/nginx-web-app</code>).</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>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.</p>"
|
|
},
|
|
"imageTagMutability":{
|
|
"shape":"ImageTagMutability",
|
|
"documentation":"<p>The tag mutability setting for the repository. If this parameter is omitted, the default setting of <code>MUTABLE</code> will be used which will allow image tags to be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</p>"
|
|
},
|
|
"imageScanningConfiguration":{
|
|
"shape":"ImageScanningConfiguration",
|
|
"documentation":"<p>The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.</p>"
|
|
},
|
|
"encryptionConfiguration":{
|
|
"shape":"EncryptionConfiguration",
|
|
"documentation":"<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateRepositoryResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repository":{
|
|
"shape":"Repository",
|
|
"documentation":"<p>The repository that was created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreationTimestamp":{"type":"timestamp"},
|
|
"CvssScore":{
|
|
"type":"structure",
|
|
"members":{
|
|
"baseScore":{
|
|
"shape":"BaseScore",
|
|
"documentation":"<p>The base CVSS score used for the finding.</p>"
|
|
},
|
|
"scoringVector":{
|
|
"shape":"ScoringVector",
|
|
"documentation":"<p>The vector string of the CVSS score.</p>"
|
|
},
|
|
"source":{
|
|
"shape":"Source",
|
|
"documentation":"<p>The source of the CVSS score.</p>"
|
|
},
|
|
"version":{
|
|
"shape":"Version",
|
|
"documentation":"<p>The version of CVSS used for the score.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The CVSS score for a finding.</p>"
|
|
},
|
|
"CvssScoreAdjustment":{
|
|
"type":"structure",
|
|
"members":{
|
|
"metric":{
|
|
"shape":"Metric",
|
|
"documentation":"<p>The metric used to adjust the CVSS score.</p>"
|
|
},
|
|
"reason":{
|
|
"shape":"Reason",
|
|
"documentation":"<p>The reason the CVSS score has been adjustment.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Details on adjustments Amazon Inspector made to the CVSS score for a finding.</p>"
|
|
},
|
|
"CvssScoreAdjustmentList":{
|
|
"type":"list",
|
|
"member":{"shape":"CvssScoreAdjustment"}
|
|
},
|
|
"CvssScoreDetails":{
|
|
"type":"structure",
|
|
"members":{
|
|
"adjustments":{
|
|
"shape":"CvssScoreAdjustmentList",
|
|
"documentation":"<p>An object that contains details about adjustment Amazon Inspector made to the CVSS score.</p>"
|
|
},
|
|
"score":{
|
|
"shape":"Score",
|
|
"documentation":"<p>The CVSS score.</p>"
|
|
},
|
|
"scoreSource":{
|
|
"shape":"Source",
|
|
"documentation":"<p>The source for the CVSS score.</p>"
|
|
},
|
|
"scoringVector":{
|
|
"shape":"ScoringVector",
|
|
"documentation":"<p>The vector for the CVSS score.</p>"
|
|
},
|
|
"version":{
|
|
"shape":"Version",
|
|
"documentation":"<p>The CVSS version used in scoring.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information about the CVSS score.</p>"
|
|
},
|
|
"CvssScoreList":{
|
|
"type":"list",
|
|
"member":{"shape":"CvssScore"}
|
|
},
|
|
"Date":{"type":"timestamp"},
|
|
"DeleteLifecyclePolicyRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteLifecyclePolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON lifecycle policy text.</p>"
|
|
},
|
|
"lastEvaluatedAt":{
|
|
"shape":"EvaluationTimestamp",
|
|
"documentation":"<p>The time stamp of the last time that the lifecycle policy was run.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeletePullThroughCacheRuleRequest":{
|
|
"type":"structure",
|
|
"required":["ecrRepositoryPrefix"],
|
|
"members":{
|
|
"ecrRepositoryPrefix":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefix",
|
|
"documentation":"<p>The Amazon ECR repository prefix associated with the pull through cache rule to delete.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeletePullThroughCacheRuleResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ecrRepositoryPrefix":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefix",
|
|
"documentation":"<p>The Amazon ECR repository prefix associated with the request.</p>"
|
|
},
|
|
"upstreamRegistryUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The upstream registry URL associated with the pull through cache rule.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"CreationTimestamp",
|
|
"documentation":"<p>The timestamp associated with the pull through cache rule.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRegistryPolicyRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"DeleteRegistryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RegistryPolicyText",
|
|
"documentation":"<p>The contents of the registry permissions policy that was deleted.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRepositoryPolicyRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository that is associated with the repository policy to delete.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRepositoryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RepositoryPolicyText",
|
|
"documentation":"<p>The JSON repository policy that was deleted from the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRepositoryRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to delete.</p>"
|
|
},
|
|
"force":{
|
|
"shape":"ForceFlag",
|
|
"documentation":"<p> If a repository contains images, forces the deletion.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteRepositoryResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repository":{
|
|
"shape":"Repository",
|
|
"documentation":"<p>The repository that was deleted.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImageReplicationStatusRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageId"
|
|
],
|
|
"members":{
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository that the image is in.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImageReplicationStatusResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"},
|
|
"replicationStatuses":{
|
|
"shape":"ImageReplicationStatusList",
|
|
"documentation":"<p>The replication status details for the images in the specified repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImageScanFindingsRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageId"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository for the image for which to describe the scan findings.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeImageScanFindings</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of image scan results returned by <code>DescribeImageScanFindings</code> in paginated output. When this parameter is used, <code>DescribeImageScanFindings</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeImageScanFindings</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribeImageScanFindings</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImageScanFindingsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"},
|
|
"imageScanStatus":{
|
|
"shape":"ImageScanStatus",
|
|
"documentation":"<p>The current state of the scan.</p>"
|
|
},
|
|
"imageScanFindings":{
|
|
"shape":"ImageScanFindings",
|
|
"documentation":"<p>The information contained in the image scan findings.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribeImageScanFindings</code> request. When the results of a <code>DescribeImageScanFindings</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImagesFilter":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tagStatus":{
|
|
"shape":"TagStatus",
|
|
"documentation":"<p>The tag status with which to filter your <a>DescribeImages</a> results. You can filter results based on whether they are <code>TAGGED</code> or <code>UNTAGGED</code>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing a filter on a <a>DescribeImages</a> operation.</p>"
|
|
},
|
|
"DescribeImagesRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository that contains the images to describe.</p>"
|
|
},
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>The list of image IDs for the requested repository.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify images with <code>imageIds</code>.</p>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of repository results returned by <code>DescribeImages</code> in paginated output. When this parameter is used, <code>DescribeImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribeImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify images with <code>imageIds</code>.</p>"
|
|
},
|
|
"filter":{
|
|
"shape":"DescribeImagesFilter",
|
|
"documentation":"<p>The filter key and value with which to filter your <code>DescribeImages</code> results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeImagesResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageDetails":{
|
|
"shape":"ImageDetailList",
|
|
"documentation":"<p>A list of <a>ImageDetail</a> objects that contain data about the image.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribeImages</code> request. When the results of a <code>DescribeImages</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribePullThroughCacheRulesRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"ecrRepositoryPrefixes":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefixList",
|
|
"documentation":"<p>The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribePullThroughCacheRulesRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of pull through cache rules returned by <code>DescribePullThroughCacheRulesRequest</code> in paginated output. When this parameter is used, <code>DescribePullThroughCacheRulesRequest</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribePullThroughCacheRulesRequest</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribePullThroughCacheRulesRequest</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribePullThroughCacheRulesResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"pullThroughCacheRules":{
|
|
"shape":"PullThroughCacheRuleList",
|
|
"documentation":"<p>The details of the pull through cache rules.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribePullThroughCacheRulesRequest</code> request. When the results of a <code>DescribePullThroughCacheRulesRequest</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeRegistryRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"DescribeRegistryResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The ID of the registry.</p>"
|
|
},
|
|
"replicationConfiguration":{
|
|
"shape":"ReplicationConfiguration",
|
|
"documentation":"<p>The replication configuration for the registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeRepositoriesRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryNames":{
|
|
"shape":"RepositoryNameList",
|
|
"documentation":"<p>A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeRepositories</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify repositories with <code>repositoryNames</code>.</p> <note> <p>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.</p> </note>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of repository results returned by <code>DescribeRepositories</code> in paginated output. When this parameter is used, <code>DescribeRepositories</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeRepositories</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>DescribeRepositories</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify repositories with <code>repositoryNames</code>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DescribeRepositoriesResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repositories":{
|
|
"shape":"RepositoryList",
|
|
"documentation":"<p>A list of repository objects corresponding to valid repositories.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribeRepositories</code> request. When the results of a <code>DescribeRepositories</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
|
}
|
|
}
|
|
},
|
|
"EmptyUploadException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified layer upload does not contain any layer parts.</p>",
|
|
"exception":true
|
|
},
|
|
"EncryptionConfiguration":{
|
|
"type":"structure",
|
|
"required":["encryptionType"],
|
|
"members":{
|
|
"encryptionType":{
|
|
"shape":"EncryptionType",
|
|
"documentation":"<p>The encryption type to use.</p> <p>If you use the <code>KMS</code> encryption type, the contents of the repository will be encrypted using server-side encryption with Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html\">Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS)</a> in the <i>Amazon Simple Storage Service Console Developer Guide</i>.</p> <p>If you use the <code>AES256</code> encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html\">Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)</a> in the <i>Amazon Simple Storage Service Console Developer Guide</i>.</p>"
|
|
},
|
|
"kmsKey":{
|
|
"shape":"KmsKey",
|
|
"documentation":"<p>If you use the <code>KMS</code> encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p> <p>By default, when no encryption configuration is set or the <code>AES256</code> encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part.</p> <p>For more control over the encryption of the contents of your repository, you can use server-side encryption with Key Management Service key stored in Key Management Service (KMS) to encrypt your images. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html\">Amazon ECR encryption at rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"EncryptionType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"AES256",
|
|
"KMS"
|
|
]
|
|
},
|
|
"EnhancedImageScanFinding":{
|
|
"type":"structure",
|
|
"members":{
|
|
"awsAccountId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the image.</p>"
|
|
},
|
|
"description":{
|
|
"shape":"FindingDescription",
|
|
"documentation":"<p>The description of the finding.</p>"
|
|
},
|
|
"findingArn":{
|
|
"shape":"FindingArn",
|
|
"documentation":"<p>The Amazon Resource Number (ARN) of the finding.</p>"
|
|
},
|
|
"firstObservedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time that the finding was first observed.</p>"
|
|
},
|
|
"lastObservedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time that the finding was last observed.</p>"
|
|
},
|
|
"packageVulnerabilityDetails":{
|
|
"shape":"PackageVulnerabilityDetails",
|
|
"documentation":"<p>An object that contains the details of a package vulnerability finding.</p>"
|
|
},
|
|
"remediation":{
|
|
"shape":"Remediation",
|
|
"documentation":"<p>An object that contains the details about how to remediate a finding.</p>"
|
|
},
|
|
"resources":{
|
|
"shape":"ResourceList",
|
|
"documentation":"<p>Contains information on the resources involved in a finding.</p>"
|
|
},
|
|
"score":{
|
|
"shape":"Score",
|
|
"documentation":"<p>The Amazon Inspector score given to the finding.</p>"
|
|
},
|
|
"scoreDetails":{
|
|
"shape":"ScoreDetails",
|
|
"documentation":"<p>An object that contains details of the Amazon Inspector score.</p>"
|
|
},
|
|
"severity":{
|
|
"shape":"Severity",
|
|
"documentation":"<p>The severity of the finding.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"Status",
|
|
"documentation":"<p>The status of the finding.</p>"
|
|
},
|
|
"title":{
|
|
"shape":"Title",
|
|
"documentation":"<p>The title of the finding.</p>"
|
|
},
|
|
"type":{
|
|
"shape":"Type",
|
|
"documentation":"<p>The type of the finding.</p>"
|
|
},
|
|
"updatedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time the finding was last updated at.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of an enhanced image scan. This is returned when enhanced scanning is enabled for your private registry.</p>"
|
|
},
|
|
"EnhancedImageScanFindingList":{
|
|
"type":"list",
|
|
"member":{"shape":"EnhancedImageScanFinding"}
|
|
},
|
|
"Epoch":{"type":"integer"},
|
|
"EvaluationTimestamp":{"type":"timestamp"},
|
|
"ExceptionMessage":{"type":"string"},
|
|
"ExpirationTimestamp":{"type":"timestamp"},
|
|
"FilePath":{"type":"string"},
|
|
"FindingArn":{"type":"string"},
|
|
"FindingDescription":{"type":"string"},
|
|
"FindingName":{"type":"string"},
|
|
"FindingSeverity":{
|
|
"type":"string",
|
|
"enum":[
|
|
"INFORMATIONAL",
|
|
"LOW",
|
|
"MEDIUM",
|
|
"HIGH",
|
|
"CRITICAL",
|
|
"UNDEFINED"
|
|
]
|
|
},
|
|
"FindingSeverityCounts":{
|
|
"type":"map",
|
|
"key":{"shape":"FindingSeverity"},
|
|
"value":{"shape":"SeverityCount"}
|
|
},
|
|
"ForceFlag":{"type":"boolean"},
|
|
"GetAuthorizationTokenRegistryIdList":{
|
|
"type":"list",
|
|
"member":{"shape":"RegistryId"},
|
|
"max":10,
|
|
"min":1
|
|
},
|
|
"GetAuthorizationTokenRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryIds":{
|
|
"shape":"GetAuthorizationTokenRegistryIdList",
|
|
"documentation":"<p>A list of Amazon Web Services 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.</p>",
|
|
"deprecated":true,
|
|
"deprecatedMessage":"This field is deprecated. The returned authorization token can be used to access any Amazon ECR registry that the IAM principal has access to, specifying a registry ID doesn't change the permissions scope of the authorization token."
|
|
}
|
|
}
|
|
},
|
|
"GetAuthorizationTokenResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"authorizationData":{
|
|
"shape":"AuthorizationDataList",
|
|
"documentation":"<p>A list of authorization token data objects that correspond to the <code>registryIds</code> values in the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetDownloadUrlForLayerRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"layerDigest"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository that is associated with the image layer to download.</p>"
|
|
},
|
|
"layerDigest":{
|
|
"shape":"LayerDigest",
|
|
"documentation":"<p>The digest of the image layer to download.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetDownloadUrlForLayerResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"downloadUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The pre-signed Amazon S3 download URL for the requested layer.</p>"
|
|
},
|
|
"layerDigest":{
|
|
"shape":"LayerDigest",
|
|
"documentation":"<p>The digest of the image layer to download.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetLifecyclePolicyPreviewRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
},
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>The list of imageIDs to be included.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated
 <code>GetLifecyclePolicyPreviewRequest</code> request where <code>maxResults</code> was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the <code>nextToken</code> value. This value is
 <code>null</code> when there are no more results to return. This option cannot be used when you specify images with <code>imageIds</code>.</p>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"LifecyclePreviewMaxResults",
|
|
"documentation":"<p>The maximum number of repository results returned by <code>GetLifecyclePolicyPreviewRequest</code> in
 paginated output. When this parameter is used, <code>GetLifecyclePolicyPreviewRequest</code> only returns
 <code>maxResults</code> results in a single page along with a <code>nextToken</code>
 response element. The remaining results of the initial request can be seen by sending
 another <code>GetLifecyclePolicyPreviewRequest</code> request with the returned <code>nextToken</code>
 value. This value can be between 1 and 1000. If this
 parameter is not used, then <code>GetLifecyclePolicyPreviewRequest</code> returns up to
 100 results and a <code>nextToken</code> value, if
 applicable. This option cannot be used when you specify images with <code>imageIds</code>.</p>"
|
|
},
|
|
"filter":{
|
|
"shape":"LifecyclePolicyPreviewFilter",
|
|
"documentation":"<p>An optional parameter that filters results based on image tag status and all tags, if tagged.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetLifecyclePolicyPreviewResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON lifecycle policy text.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"LifecyclePolicyPreviewStatus",
|
|
"documentation":"<p>The status of the lifecycle policy preview request.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>GetLifecyclePolicyPreview</code> request. When the results of a <code>GetLifecyclePolicyPreview</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
|
},
|
|
"previewResults":{
|
|
"shape":"LifecyclePolicyPreviewResultList",
|
|
"documentation":"<p>The results of the lifecycle policy preview request.</p>"
|
|
},
|
|
"summary":{
|
|
"shape":"LifecyclePolicyPreviewSummary",
|
|
"documentation":"<p>The list of images that is returned as a result of the action.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetLifecyclePolicyRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetLifecyclePolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON lifecycle policy text.</p>"
|
|
},
|
|
"lastEvaluatedAt":{
|
|
"shape":"EvaluationTimestamp",
|
|
"documentation":"<p>The time stamp of the last time that the lifecycle policy was run.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetRegistryPolicyRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"GetRegistryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The ID of the registry.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RegistryPolicyText",
|
|
"documentation":"<p>The JSON text of the permissions policy for a registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetRegistryScanningConfigurationRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"GetRegistryScanningConfigurationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The ID of the registry.</p>"
|
|
},
|
|
"scanningConfiguration":{
|
|
"shape":"RegistryScanningConfiguration",
|
|
"documentation":"<p>The scanning configuration for the registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetRepositoryPolicyRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository with the policy to retrieve.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetRepositoryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RepositoryPolicyText",
|
|
"documentation":"<p>The JSON repository policy text associated with the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Image":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry containing the image.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository associated with the image.</p>"
|
|
},
|
|
"imageId":{
|
|
"shape":"ImageIdentifier",
|
|
"documentation":"<p>An object containing the image tag and image digest associated with an image.</p>"
|
|
},
|
|
"imageManifest":{
|
|
"shape":"ImageManifest",
|
|
"documentation":"<p>The image manifest associated with the image.</p>"
|
|
},
|
|
"imageManifestMediaType":{
|
|
"shape":"MediaType",
|
|
"documentation":"<p>The manifest media type of the image.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing an Amazon ECR image.</p>"
|
|
},
|
|
"ImageActionType":{
|
|
"type":"string",
|
|
"enum":["EXPIRE"]
|
|
},
|
|
"ImageAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.</p>",
|
|
"exception":true
|
|
},
|
|
"ImageCount":{
|
|
"type":"integer",
|
|
"min":0
|
|
},
|
|
"ImageDetail":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry to which this image belongs.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to which this image belongs.</p>"
|
|
},
|
|
"imageDigest":{
|
|
"shape":"ImageDigest",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image manifest.</p>"
|
|
},
|
|
"imageTags":{
|
|
"shape":"ImageTagList",
|
|
"documentation":"<p>The list of tags associated with this image.</p>"
|
|
},
|
|
"imageSizeInBytes":{
|
|
"shape":"ImageSizeInBytes",
|
|
"documentation":"<p>The size, in bytes, of the image in the repository.</p> <p>If the image is a manifest list, this will be the max size of all manifests in the list.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>"
|
|
},
|
|
"imagePushedAt":{
|
|
"shape":"PushTimestamp",
|
|
"documentation":"<p>The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. </p>"
|
|
},
|
|
"imageScanStatus":{
|
|
"shape":"ImageScanStatus",
|
|
"documentation":"<p>The current state of the scan.</p>"
|
|
},
|
|
"imageScanFindingsSummary":{
|
|
"shape":"ImageScanFindingsSummary",
|
|
"documentation":"<p>A summary of the last completed image scan.</p>"
|
|
},
|
|
"imageManifestMediaType":{
|
|
"shape":"MediaType",
|
|
"documentation":"<p>The media type of the image manifest.</p>"
|
|
},
|
|
"artifactMediaType":{
|
|
"shape":"MediaType",
|
|
"documentation":"<p>The artifact media type of the image.</p>"
|
|
},
|
|
"lastRecordedPullTime":{
|
|
"shape":"RecordedPullTimestamp",
|
|
"documentation":"<p>The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.</p> <note> <p>Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the <code>lastRecordedPullTime</code> timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the <code>lastRecordedPullTime</code> timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.</p> </note>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object that describes an image returned by a <a>DescribeImages</a> operation.</p>"
|
|
},
|
|
"ImageDetailList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageDetail"}
|
|
},
|
|
"ImageDigest":{"type":"string"},
|
|
"ImageDigestDoesNotMatchException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The specified image digest does not match the digest that Amazon ECR calculated for the image.</p>",
|
|
"exception":true
|
|
},
|
|
"ImageFailure":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageId":{
|
|
"shape":"ImageIdentifier",
|
|
"documentation":"<p>The image ID associated with the failure.</p>"
|
|
},
|
|
"failureCode":{
|
|
"shape":"ImageFailureCode",
|
|
"documentation":"<p>The code associated with the failure.</p>"
|
|
},
|
|
"failureReason":{
|
|
"shape":"ImageFailureReason",
|
|
"documentation":"<p>The reason for the failure.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing an Amazon ECR image failure.</p>"
|
|
},
|
|
"ImageFailureCode":{
|
|
"type":"string",
|
|
"enum":[
|
|
"InvalidImageDigest",
|
|
"InvalidImageTag",
|
|
"ImageTagDoesNotMatchDigest",
|
|
"ImageNotFound",
|
|
"MissingDigestAndTag",
|
|
"ImageReferencedByManifestList",
|
|
"KmsError"
|
|
]
|
|
},
|
|
"ImageFailureList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageFailure"}
|
|
},
|
|
"ImageFailureReason":{"type":"string"},
|
|
"ImageIdentifier":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageDigest":{
|
|
"shape":"ImageDigest",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image manifest.</p>"
|
|
},
|
|
"imageTag":{
|
|
"shape":"ImageTag",
|
|
"documentation":"<p>The tag used for the image.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object with identifying information for an image in an Amazon ECR repository.</p>"
|
|
},
|
|
"ImageIdentifierList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageIdentifier"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"ImageList":{
|
|
"type":"list",
|
|
"member":{"shape":"Image"}
|
|
},
|
|
"ImageManifest":{
|
|
"type":"string",
|
|
"max":4194304,
|
|
"min":1
|
|
},
|
|
"ImageNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The image requested does not exist in the specified repository.</p>",
|
|
"exception":true
|
|
},
|
|
"ImageReplicationStatus":{
|
|
"type":"structure",
|
|
"members":{
|
|
"region":{
|
|
"shape":"Region",
|
|
"documentation":"<p>The destination Region for the image replication.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry to which the image belongs.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"ReplicationStatus",
|
|
"documentation":"<p>The image replication status.</p>"
|
|
},
|
|
"failureCode":{
|
|
"shape":"ReplicationError",
|
|
"documentation":"<p>The failure code for a replication that has failed.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The status of the replication process for an image.</p>"
|
|
},
|
|
"ImageReplicationStatusList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageReplicationStatus"}
|
|
},
|
|
"ImageScanFinding":{
|
|
"type":"structure",
|
|
"members":{
|
|
"name":{
|
|
"shape":"FindingName",
|
|
"documentation":"<p>The name associated with the finding, usually a CVE number.</p>"
|
|
},
|
|
"description":{
|
|
"shape":"FindingDescription",
|
|
"documentation":"<p>The description of the finding.</p>"
|
|
},
|
|
"uri":{
|
|
"shape":"Url",
|
|
"documentation":"<p>A link containing additional details about the security vulnerability.</p>"
|
|
},
|
|
"severity":{
|
|
"shape":"FindingSeverity",
|
|
"documentation":"<p>The finding severity.</p>"
|
|
},
|
|
"attributes":{
|
|
"shape":"AttributeList",
|
|
"documentation":"<p>A collection of attributes of the host from which the finding is generated.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Contains information about an image scan finding.</p>"
|
|
},
|
|
"ImageScanFindingList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageScanFinding"}
|
|
},
|
|
"ImageScanFindings":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageScanCompletedAt":{
|
|
"shape":"ScanTimestamp",
|
|
"documentation":"<p>The time of the last completed image scan.</p>"
|
|
},
|
|
"vulnerabilitySourceUpdatedAt":{
|
|
"shape":"VulnerabilitySourceUpdateTimestamp",
|
|
"documentation":"<p>The time when the vulnerability data was last scanned.</p>"
|
|
},
|
|
"findingSeverityCounts":{
|
|
"shape":"FindingSeverityCounts",
|
|
"documentation":"<p>The image vulnerability counts, sorted by severity.</p>"
|
|
},
|
|
"findings":{
|
|
"shape":"ImageScanFindingList",
|
|
"documentation":"<p>The findings from the image scan.</p>"
|
|
},
|
|
"enhancedFindings":{
|
|
"shape":"EnhancedImageScanFindingList",
|
|
"documentation":"<p>Details about the enhanced scan findings from Amazon Inspector.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of an image scan.</p>"
|
|
},
|
|
"ImageScanFindingsSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageScanCompletedAt":{
|
|
"shape":"ScanTimestamp",
|
|
"documentation":"<p>The time of the last completed image scan.</p>"
|
|
},
|
|
"vulnerabilitySourceUpdatedAt":{
|
|
"shape":"VulnerabilitySourceUpdateTimestamp",
|
|
"documentation":"<p>The time when the vulnerability data was last scanned.</p>"
|
|
},
|
|
"findingSeverityCounts":{
|
|
"shape":"FindingSeverityCounts",
|
|
"documentation":"<p>The image vulnerability counts, sorted by severity.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A summary of the last completed image scan.</p>"
|
|
},
|
|
"ImageScanStatus":{
|
|
"type":"structure",
|
|
"members":{
|
|
"status":{
|
|
"shape":"ScanStatus",
|
|
"documentation":"<p>The current state of an image scan.</p>"
|
|
},
|
|
"description":{
|
|
"shape":"ScanStatusDescription",
|
|
"documentation":"<p>The description of the image scan status.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The current status of an image scan.</p>"
|
|
},
|
|
"ImageScanningConfiguration":{
|
|
"type":"structure",
|
|
"members":{
|
|
"scanOnPush":{
|
|
"shape":"ScanOnPushFlag",
|
|
"documentation":"<p>The setting that determines whether images are scanned after being pushed to a repository. If set to <code>true</code>, images will be scanned after being pushed. If this parameter is not specified, it will default to <code>false</code> and images will not be scanned unless a scan is manually started with the <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.html\">API_StartImageScan</a> API.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The image scanning configuration for a repository.</p>"
|
|
},
|
|
"ImageSizeInBytes":{"type":"long"},
|
|
"ImageTag":{
|
|
"type":"string",
|
|
"max":300,
|
|
"min":1
|
|
},
|
|
"ImageTagAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.</p>",
|
|
"exception":true
|
|
},
|
|
"ImageTagList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageTag"}
|
|
},
|
|
"ImageTagMutability":{
|
|
"type":"string",
|
|
"enum":[
|
|
"MUTABLE",
|
|
"IMMUTABLE"
|
|
]
|
|
},
|
|
"ImageTagsList":{
|
|
"type":"list",
|
|
"member":{"shape":"ImageTag"}
|
|
},
|
|
"InitiateLayerUploadRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to which you intend to upload layers.</p>"
|
|
}
|
|
}
|
|
},
|
|
"InitiateLayerUploadResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID for the layer upload. This parameter is passed to further <a>UploadLayerPart</a> and <a>CompleteLayerUpload</a> operations.</p>"
|
|
},
|
|
"partSize":{
|
|
"shape":"PartSize",
|
|
"documentation":"<p>The size, in bytes, that Amazon ECR expects future layer part uploads to be.</p>"
|
|
}
|
|
}
|
|
},
|
|
"InvalidLayerException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidLayerPartException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the exception.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the exception.</p>"
|
|
},
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID associated with the exception.</p>"
|
|
},
|
|
"lastValidByteReceived":{
|
|
"shape":"PartSize",
|
|
"documentation":"<p>The last valid byte received from the layer part upload that is associated with the exception.</p>"
|
|
},
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>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.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidParameterException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
|
|
"exception":true
|
|
},
|
|
"InvalidTagParameterException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>",
|
|
"exception":true
|
|
},
|
|
"KmsError":{"type":"string"},
|
|
"KmsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"},
|
|
"kmsError":{
|
|
"shape":"KmsError",
|
|
"documentation":"<p>The error code returned by KMS.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The operation failed due to a KMS exception.</p>",
|
|
"exception":true
|
|
},
|
|
"KmsKey":{
|
|
"type":"string",
|
|
"max":2048,
|
|
"min":1
|
|
},
|
|
"Layer":{
|
|
"type":"structure",
|
|
"members":{
|
|
"layerDigest":{
|
|
"shape":"LayerDigest",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image layer.</p>"
|
|
},
|
|
"layerAvailability":{
|
|
"shape":"LayerAvailability",
|
|
"documentation":"<p>The availability status of the image layer.</p>"
|
|
},
|
|
"layerSize":{
|
|
"shape":"LayerSizeInBytes",
|
|
"documentation":"<p>The size, in bytes, of the image layer.</p>"
|
|
},
|
|
"mediaType":{
|
|
"shape":"MediaType",
|
|
"documentation":"<p>The media type of the layer, such as <code>application/vnd.docker.image.rootfs.diff.tar.gzip</code> or <code>application/vnd.oci.image.layer.v1.tar+gzip</code>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing an Amazon ECR image layer.</p>"
|
|
},
|
|
"LayerAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The image layer already exists in the associated repository.</p>",
|
|
"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":"<p>The layer digest associated with the failure.</p>"
|
|
},
|
|
"failureCode":{
|
|
"shape":"LayerFailureCode",
|
|
"documentation":"<p>The failure code associated with the failure.</p>"
|
|
},
|
|
"failureReason":{
|
|
"shape":"LayerFailureReason",
|
|
"documentation":"<p>The reason for the failure.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing an Amazon ECR image layer failure.</p>"
|
|
},
|
|
"LayerFailureCode":{
|
|
"type":"string",
|
|
"enum":[
|
|
"InvalidLayerDigest",
|
|
"MissingLayerDigest"
|
|
]
|
|
},
|
|
"LayerFailureList":{
|
|
"type":"list",
|
|
"member":{"shape":"LayerFailure"}
|
|
},
|
|
"LayerFailureReason":{"type":"string"},
|
|
"LayerInaccessibleException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.</p>",
|
|
"exception":true
|
|
},
|
|
"LayerList":{
|
|
"type":"list",
|
|
"member":{"shape":"Layer"}
|
|
},
|
|
"LayerPartBlob":{
|
|
"type":"blob",
|
|
"max":20971520,
|
|
"min":0
|
|
},
|
|
"LayerPartTooSmallException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Layer parts must be at least 5 MiB in size.</p>",
|
|
"exception":true
|
|
},
|
|
"LayerSizeInBytes":{"type":"long"},
|
|
"LayersNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified layers could not be found, or the specified layer is not valid for this repository.</p>",
|
|
"exception":true
|
|
},
|
|
"LifecyclePolicyNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The lifecycle policy could not be found, and no policy is set to the repository.</p>",
|
|
"exception":true
|
|
},
|
|
"LifecyclePolicyPreviewFilter":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tagStatus":{
|
|
"shape":"TagStatus",
|
|
"documentation":"<p>The tag status of the image.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The filter for the lifecycle policy preview.</p>"
|
|
},
|
|
"LifecyclePolicyPreviewInProgressException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The previous lifecycle policy preview request has not completed. Wait and try again.</p>",
|
|
"exception":true
|
|
},
|
|
"LifecyclePolicyPreviewNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>There is no dry run for this repository.</p>",
|
|
"exception":true
|
|
},
|
|
"LifecyclePolicyPreviewResult":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageTags":{
|
|
"shape":"ImageTagList",
|
|
"documentation":"<p>The list of tags associated with this image.</p>"
|
|
},
|
|
"imageDigest":{
|
|
"shape":"ImageDigest",
|
|
"documentation":"<p>The <code>sha256</code> digest of the image manifest.</p>"
|
|
},
|
|
"imagePushedAt":{
|
|
"shape":"PushTimestamp",
|
|
"documentation":"<p>The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.</p>"
|
|
},
|
|
"action":{
|
|
"shape":"LifecyclePolicyRuleAction",
|
|
"documentation":"<p>The type of action to be taken.</p>"
|
|
},
|
|
"appliedRulePriority":{
|
|
"shape":"LifecyclePolicyRulePriority",
|
|
"documentation":"<p>The priority of the applied rule.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The result of the lifecycle policy preview.</p>"
|
|
},
|
|
"LifecyclePolicyPreviewResultList":{
|
|
"type":"list",
|
|
"member":{"shape":"LifecyclePolicyPreviewResult"}
|
|
},
|
|
"LifecyclePolicyPreviewStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"IN_PROGRESS",
|
|
"COMPLETE",
|
|
"EXPIRED",
|
|
"FAILED"
|
|
]
|
|
},
|
|
"LifecyclePolicyPreviewSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"expiringImageTotalCount":{
|
|
"shape":"ImageCount",
|
|
"documentation":"<p>The number of expiring images.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The summary of the lifecycle policy preview request.</p>"
|
|
},
|
|
"LifecyclePolicyRuleAction":{
|
|
"type":"structure",
|
|
"members":{
|
|
"type":{
|
|
"shape":"ImageActionType",
|
|
"documentation":"<p>The type of action to be taken.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The type of action to be taken.</p>"
|
|
},
|
|
"LifecyclePolicyRulePriority":{
|
|
"type":"integer",
|
|
"min":1
|
|
},
|
|
"LifecyclePolicyText":{
|
|
"type":"string",
|
|
"max":30720,
|
|
"min":100
|
|
},
|
|
"LifecyclePreviewMaxResults":{
|
|
"type":"integer",
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"LimitExceededException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The operation did not succeed because it would have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html\">Amazon ECR service quotas</a> in the Amazon Elastic Container Registry User Guide.</p>",
|
|
"exception":true
|
|
},
|
|
"ListImagesFilter":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tagStatus":{
|
|
"shape":"TagStatus",
|
|
"documentation":"<p>The tag status with which to filter your <a>ListImages</a> results. You can filter results based on whether they are <code>TAGGED</code> or <code>UNTAGGED</code>.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing a filter on a <a>ListImages</a> operation.</p>"
|
|
},
|
|
"ListImagesRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository with image IDs to be listed.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListImages</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>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.</p> </note>"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of image results returned by <code>ListImages</code> in paginated output. When this parameter is used, <code>ListImages</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListImages</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 1000. If this parameter is not used, then <code>ListImages</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"
|
|
},
|
|
"filter":{
|
|
"shape":"ListImagesFilter",
|
|
"documentation":"<p>The filter key and value with which to filter your <code>ListImages</code> results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListImagesResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"imageIds":{
|
|
"shape":"ImageIdentifierList",
|
|
"documentation":"<p>The list of image IDs for the requested repository.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"NextToken",
|
|
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>ListImages</code> request. When the results of a <code>ListImages</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceRequest":{
|
|
"type":"structure",
|
|
"required":["resourceArn"],
|
|
"members":{
|
|
"resourceArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>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.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>The tags for the resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"MaxResults":{
|
|
"type":"integer",
|
|
"max":1000,
|
|
"min":1
|
|
},
|
|
"MediaType":{"type":"string"},
|
|
"MediaTypeList":{
|
|
"type":"list",
|
|
"member":{"shape":"MediaType"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"Metric":{"type":"string"},
|
|
"NextToken":{"type":"string"},
|
|
"PackageManager":{"type":"string"},
|
|
"PackageVulnerabilityDetails":{
|
|
"type":"structure",
|
|
"members":{
|
|
"cvss":{
|
|
"shape":"CvssScoreList",
|
|
"documentation":"<p>An object that contains details about the CVSS score of a finding.</p>"
|
|
},
|
|
"referenceUrls":{
|
|
"shape":"ReferenceUrlsList",
|
|
"documentation":"<p>One or more URLs that contain details about this vulnerability type.</p>"
|
|
},
|
|
"relatedVulnerabilities":{
|
|
"shape":"RelatedVulnerabilitiesList",
|
|
"documentation":"<p>One or more vulnerabilities related to the one identified in this finding.</p>"
|
|
},
|
|
"source":{
|
|
"shape":"Source",
|
|
"documentation":"<p>The source of the vulnerability information.</p>"
|
|
},
|
|
"sourceUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>A URL to the source of the vulnerability information.</p>"
|
|
},
|
|
"vendorCreatedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time that this vulnerability was first added to the vendor's database.</p>"
|
|
},
|
|
"vendorSeverity":{
|
|
"shape":"Severity",
|
|
"documentation":"<p>The severity the vendor has given to this vulnerability type.</p>"
|
|
},
|
|
"vendorUpdatedAt":{
|
|
"shape":"Date",
|
|
"documentation":"<p>The date and time the vendor last updated this vulnerability in their database.</p>"
|
|
},
|
|
"vulnerabilityId":{
|
|
"shape":"VulnerabilityId",
|
|
"documentation":"<p>The ID given to this vulnerability.</p>"
|
|
},
|
|
"vulnerablePackages":{
|
|
"shape":"VulnerablePackagesList",
|
|
"documentation":"<p>The packages impacted by this vulnerability.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information about a package vulnerability finding.</p>"
|
|
},
|
|
"PartSize":{
|
|
"type":"long",
|
|
"min":0
|
|
},
|
|
"Platform":{"type":"string"},
|
|
"ProxyEndpoint":{"type":"string"},
|
|
"PullThroughCacheRule":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ecrRepositoryPrefix":{
|
|
"shape":"PullThroughCacheRuleRepositoryPrefix",
|
|
"documentation":"<p>The Amazon ECR repository prefix associated with the pull through cache rule.</p>"
|
|
},
|
|
"upstreamRegistryUrl":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The upstream registry URL associated with the pull through cache rule.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"CreationTimestamp",
|
|
"documentation":"<p>The date and time the pull through cache was created.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry the pull through cache rule is associated with.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of a pull through cache rule.</p>"
|
|
},
|
|
"PullThroughCacheRuleAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>A pull through cache rule with these settings already exists for the private registry.</p>",
|
|
"exception":true
|
|
},
|
|
"PullThroughCacheRuleList":{
|
|
"type":"list",
|
|
"member":{"shape":"PullThroughCacheRule"}
|
|
},
|
|
"PullThroughCacheRuleNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The pull through cache rule was not found. Specify a valid pull through cache rule and try again.</p>",
|
|
"exception":true
|
|
},
|
|
"PullThroughCacheRuleRepositoryPrefix":{
|
|
"type":"string",
|
|
"max":20,
|
|
"min":2,
|
|
"pattern":"[a-z0-9]+(?:[._-][a-z0-9]+)*"
|
|
},
|
|
"PullThroughCacheRuleRepositoryPrefixList":{
|
|
"type":"list",
|
|
"member":{"shape":"PullThroughCacheRuleRepositoryPrefix"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"PushTimestamp":{"type":"timestamp"},
|
|
"PutImageRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageManifest"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository in which to put the image.</p>"
|
|
},
|
|
"imageManifest":{
|
|
"shape":"ImageManifest",
|
|
"documentation":"<p>The image manifest corresponding to the image to be uploaded.</p>"
|
|
},
|
|
"imageManifestMediaType":{
|
|
"shape":"MediaType",
|
|
"documentation":"<p>The media type of the image manifest. If you push an image manifest that does not contain the <code>mediaType</code> field, you must specify the <code>imageManifestMediaType</code> in the request.</p>"
|
|
},
|
|
"imageTag":{
|
|
"shape":"ImageTag",
|
|
"documentation":"<p>The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.</p>"
|
|
},
|
|
"imageDigest":{
|
|
"shape":"ImageDigest",
|
|
"documentation":"<p>The image digest of the image manifest corresponding to the image.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutImageResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"image":{
|
|
"shape":"Image",
|
|
"documentation":"<p>Details of the image uploaded.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutImageScanningConfigurationRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageScanningConfiguration"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository in which to update the image scanning configuration setting.</p>"
|
|
},
|
|
"imageScanningConfiguration":{
|
|
"shape":"ImageScanningConfiguration",
|
|
"documentation":"<p>The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutImageScanningConfigurationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"imageScanningConfiguration":{
|
|
"shape":"ImageScanningConfiguration",
|
|
"documentation":"<p>The image scanning configuration setting for the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutImageTagMutabilityRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageTagMutability"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository in which to update the image tag mutability settings.</p>"
|
|
},
|
|
"imageTagMutability":{
|
|
"shape":"ImageTagMutability",
|
|
"documentation":"<p>The tag mutability setting for the repository. If <code>MUTABLE</code> is specified, image tags can be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutImageTagMutabilityResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"imageTagMutability":{
|
|
"shape":"ImageTagMutability",
|
|
"documentation":"<p>The image tag mutability setting for the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutLifecyclePolicyRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"lifecyclePolicyText"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to receive the policy.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON repository policy text to apply to the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutLifecyclePolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON repository policy text.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutRegistryPolicyRequest":{
|
|
"type":"structure",
|
|
"required":["policyText"],
|
|
"members":{
|
|
"policyText":{
|
|
"shape":"RegistryPolicyText",
|
|
"documentation":"<p>The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html\">Registry permissions</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutRegistryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RegistryPolicyText",
|
|
"documentation":"<p>The JSON policy text for your registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutRegistryScanningConfigurationRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"scanType":{
|
|
"shape":"ScanType",
|
|
"documentation":"<p>The scanning type to set for the registry.</p> <p>When a registry scanning configuration is not defined, by default the <code>BASIC</code> scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.</p> <p>When the <code>ENHANCED</code> scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.</p>"
|
|
},
|
|
"rules":{
|
|
"shape":"RegistryScanningRuleList",
|
|
"documentation":"<p>The scanning rules to use for the registry. A scanning rule is used to determine which repository filters are used and at what frequency scanning will occur.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutRegistryScanningConfigurationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryScanningConfiguration":{
|
|
"shape":"RegistryScanningConfiguration",
|
|
"documentation":"<p>The scanning configuration for your registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutReplicationConfigurationRequest":{
|
|
"type":"structure",
|
|
"required":["replicationConfiguration"],
|
|
"members":{
|
|
"replicationConfiguration":{
|
|
"shape":"ReplicationConfiguration",
|
|
"documentation":"<p>An object representing the replication configuration for a registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"PutReplicationConfigurationResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"replicationConfiguration":{
|
|
"shape":"ReplicationConfiguration",
|
|
"documentation":"<p>The contents of the replication configuration for the registry.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Reason":{"type":"string"},
|
|
"Recommendation":{
|
|
"type":"structure",
|
|
"members":{
|
|
"url":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The URL address to the CVE remediation recommendations.</p>"
|
|
},
|
|
"text":{
|
|
"shape":"RecommendationText",
|
|
"documentation":"<p>The recommended course of action to remediate the finding.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Details about the recommended course of action to remediate the finding.</p>"
|
|
},
|
|
"RecommendationText":{"type":"string"},
|
|
"RecordedPullTimestamp":{"type":"timestamp"},
|
|
"ReferenceUrlsList":{
|
|
"type":"list",
|
|
"member":{"shape":"Url"}
|
|
},
|
|
"ReferencedImagesNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The manifest list is referencing an image that does not exist.</p>",
|
|
"exception":true
|
|
},
|
|
"Region":{
|
|
"type":"string",
|
|
"max":25,
|
|
"min":2,
|
|
"pattern":"[0-9a-z-]{2,25}"
|
|
},
|
|
"RegistryId":{
|
|
"type":"string",
|
|
"pattern":"[0-9]{12}"
|
|
},
|
|
"RegistryPolicyNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The registry doesn't have an associated registry policy.</p>",
|
|
"exception":true
|
|
},
|
|
"RegistryPolicyText":{
|
|
"type":"string",
|
|
"max":10240,
|
|
"min":0
|
|
},
|
|
"RegistryScanningConfiguration":{
|
|
"type":"structure",
|
|
"members":{
|
|
"scanType":{
|
|
"shape":"ScanType",
|
|
"documentation":"<p>The type of scanning configured for the registry.</p>"
|
|
},
|
|
"rules":{
|
|
"shape":"RegistryScanningRuleList",
|
|
"documentation":"<p>The scanning rules associated with the registry.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The scanning configuration for a private registry.</p>"
|
|
},
|
|
"RegistryScanningRule":{
|
|
"type":"structure",
|
|
"required":[
|
|
"scanFrequency",
|
|
"repositoryFilters"
|
|
],
|
|
"members":{
|
|
"scanFrequency":{
|
|
"shape":"ScanFrequency",
|
|
"documentation":"<p>The frequency that scans are performed at for a private registry. When the <code>ENHANCED</code> scan type is specified, the supported scan frequencies are <code>CONTINUOUS_SCAN</code> and <code>SCAN_ON_PUSH</code>. When the <code>BASIC</code> scan type is specified, the <code>SCAN_ON_PUSH</code> and <code>MANUAL</code> scan frequencies are supported.</p>"
|
|
},
|
|
"repositoryFilters":{
|
|
"shape":"ScanningRepositoryFilterList",
|
|
"documentation":"<p>The repository filters associated with the scanning configuration for a private registry.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of a scanning rule for a private registry.</p>"
|
|
},
|
|
"RegistryScanningRuleList":{
|
|
"type":"list",
|
|
"member":{"shape":"RegistryScanningRule"},
|
|
"max":2,
|
|
"min":0
|
|
},
|
|
"RelatedVulnerabilitiesList":{
|
|
"type":"list",
|
|
"member":{"shape":"RelatedVulnerability"}
|
|
},
|
|
"RelatedVulnerability":{"type":"string"},
|
|
"Release":{"type":"string"},
|
|
"Remediation":{
|
|
"type":"structure",
|
|
"members":{
|
|
"recommendation":{
|
|
"shape":"Recommendation",
|
|
"documentation":"<p>An object that contains information about the recommended course of action to remediate the finding.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information on how to remediate a finding.</p>"
|
|
},
|
|
"ReplicationConfiguration":{
|
|
"type":"structure",
|
|
"required":["rules"],
|
|
"members":{
|
|
"rules":{
|
|
"shape":"ReplicationRuleList",
|
|
"documentation":"<p>An array of objects representing the replication destinations and repository filters for a replication configuration.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The replication configuration for a registry.</p>"
|
|
},
|
|
"ReplicationDestination":{
|
|
"type":"structure",
|
|
"required":[
|
|
"region",
|
|
"registryId"
|
|
],
|
|
"members":{
|
|
"region":{
|
|
"shape":"Region",
|
|
"documentation":"<p>The Region to replicate to.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An array of objects representing the destination for a replication rule.</p>"
|
|
},
|
|
"ReplicationDestinationList":{
|
|
"type":"list",
|
|
"member":{"shape":"ReplicationDestination"},
|
|
"max":25,
|
|
"min":0
|
|
},
|
|
"ReplicationError":{"type":"string"},
|
|
"ReplicationRule":{
|
|
"type":"structure",
|
|
"required":["destinations"],
|
|
"members":{
|
|
"destinations":{
|
|
"shape":"ReplicationDestinationList",
|
|
"documentation":"<p>An array of objects representing the destination for a replication rule.</p>"
|
|
},
|
|
"repositoryFilters":{
|
|
"shape":"RepositoryFilterList",
|
|
"documentation":"<p>An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An array of objects representing the replication destinations and repository filters for a replication configuration.</p>"
|
|
},
|
|
"ReplicationRuleList":{
|
|
"type":"list",
|
|
"member":{"shape":"ReplicationRule"},
|
|
"max":10,
|
|
"min":0
|
|
},
|
|
"ReplicationStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"IN_PROGRESS",
|
|
"COMPLETE",
|
|
"FAILED"
|
|
]
|
|
},
|
|
"Repository":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repositoryArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the <code>arn:aws:ecr</code> namespace, followed by the region of the repository, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, <code>arn:aws:ecr:region:012345678910:repository/test</code>.</p>"
|
|
},
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
},
|
|
"repositoryUri":{
|
|
"shape":"Url",
|
|
"documentation":"<p>The URI for the repository. You can use this URI for container image <code>push</code> and <code>pull</code> operations.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"CreationTimestamp",
|
|
"documentation":"<p>The date and time, in JavaScript date format, when the repository was created.</p>"
|
|
},
|
|
"imageTagMutability":{
|
|
"shape":"ImageTagMutability",
|
|
"documentation":"<p>The tag mutability setting for the repository.</p>"
|
|
},
|
|
"imageScanningConfiguration":{"shape":"ImageScanningConfiguration"},
|
|
"encryptionConfiguration":{
|
|
"shape":"EncryptionConfiguration",
|
|
"documentation":"<p>The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An object representing a repository.</p>"
|
|
},
|
|
"RepositoryAlreadyExistsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified repository already exists in the specified registry.</p>",
|
|
"exception":true
|
|
},
|
|
"RepositoryFilter":{
|
|
"type":"structure",
|
|
"required":[
|
|
"filter",
|
|
"filterType"
|
|
],
|
|
"members":{
|
|
"filter":{
|
|
"shape":"RepositoryFilterValue",
|
|
"documentation":"<p>The repository filter details. When the <code>PREFIX_MATCH</code> filter type is specified, this value is required and should be the repository name prefix to configure replication for.</p>"
|
|
},
|
|
"filterType":{
|
|
"shape":"RepositoryFilterType",
|
|
"documentation":"<p>The repository filter type. The only supported value is <code>PREFIX_MATCH</code>, which is a repository name prefix specified with the <code>filter</code> parameter.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no repository filter is specified, all images in the repository are replicated.</p>"
|
|
},
|
|
"RepositoryFilterList":{
|
|
"type":"list",
|
|
"member":{"shape":"RepositoryFilter"},
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"RepositoryFilterType":{
|
|
"type":"string",
|
|
"enum":["PREFIX_MATCH"]
|
|
},
|
|
"RepositoryFilterValue":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":2,
|
|
"pattern":"^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$"
|
|
},
|
|
"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":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified repository contains images. To delete a repository that contains images, you must force the deletion with the <code>force</code> parameter.</p>",
|
|
"exception":true
|
|
},
|
|
"RepositoryNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>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.</p>",
|
|
"exception":true
|
|
},
|
|
"RepositoryPolicyNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The specified repository and registry combination does not have an associated repository policy.</p>",
|
|
"exception":true
|
|
},
|
|
"RepositoryPolicyText":{
|
|
"type":"string",
|
|
"max":10240,
|
|
"min":0
|
|
},
|
|
"RepositoryScanningConfiguration":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repositoryArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>The ARN of the repository.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
},
|
|
"scanOnPush":{
|
|
"shape":"ScanOnPushFlag",
|
|
"documentation":"<p>Whether or not scan on push is configured for the repository.</p>"
|
|
},
|
|
"scanFrequency":{
|
|
"shape":"ScanFrequency",
|
|
"documentation":"<p>The scan frequency for the repository.</p>"
|
|
},
|
|
"appliedScanFilters":{
|
|
"shape":"ScanningRepositoryFilterList",
|
|
"documentation":"<p>The scan filters applied to the repository.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of the scanning configuration for a repository.</p>"
|
|
},
|
|
"RepositoryScanningConfigurationFailure":{
|
|
"type":"structure",
|
|
"members":{
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository.</p>"
|
|
},
|
|
"failureCode":{
|
|
"shape":"ScanningConfigurationFailureCode",
|
|
"documentation":"<p>The failure code.</p>"
|
|
},
|
|
"failureReason":{
|
|
"shape":"ScanningConfigurationFailureReason",
|
|
"documentation":"<p>The reason for the failure.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details about any failures associated with the scanning configuration of a repository.</p>"
|
|
},
|
|
"RepositoryScanningConfigurationFailureList":{
|
|
"type":"list",
|
|
"member":{"shape":"RepositoryScanningConfigurationFailure"}
|
|
},
|
|
"RepositoryScanningConfigurationList":{
|
|
"type":"list",
|
|
"member":{"shape":"RepositoryScanningConfiguration"}
|
|
},
|
|
"Resource":{
|
|
"type":"structure",
|
|
"members":{
|
|
"details":{
|
|
"shape":"ResourceDetails",
|
|
"documentation":"<p>An object that contains details about the resource involved in a finding.</p>"
|
|
},
|
|
"id":{
|
|
"shape":"ResourceId",
|
|
"documentation":"<p>The ID of the resource.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"Tags",
|
|
"documentation":"<p>The tags attached to the resource.</p>"
|
|
},
|
|
"type":{
|
|
"shape":"Type",
|
|
"documentation":"<p>The type of resource.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Details about the resource involved in a finding.</p>"
|
|
},
|
|
"ResourceDetails":{
|
|
"type":"structure",
|
|
"members":{
|
|
"awsEcrContainerImage":{
|
|
"shape":"AwsEcrContainerImageDetails",
|
|
"documentation":"<p>An object that contains details about the Amazon ECR container image involved in the finding.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Contains details about the resource involved in the finding.</p>"
|
|
},
|
|
"ResourceId":{"type":"string"},
|
|
"ResourceList":{
|
|
"type":"list",
|
|
"member":{"shape":"Resource"}
|
|
},
|
|
"ScanFrequency":{
|
|
"type":"string",
|
|
"enum":[
|
|
"SCAN_ON_PUSH",
|
|
"CONTINUOUS_SCAN",
|
|
"MANUAL"
|
|
]
|
|
},
|
|
"ScanNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.</p>",
|
|
"exception":true
|
|
},
|
|
"ScanOnPushFlag":{"type":"boolean"},
|
|
"ScanStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"IN_PROGRESS",
|
|
"COMPLETE",
|
|
"FAILED",
|
|
"UNSUPPORTED_IMAGE",
|
|
"ACTIVE",
|
|
"PENDING",
|
|
"SCAN_ELIGIBILITY_EXPIRED",
|
|
"FINDINGS_UNAVAILABLE"
|
|
]
|
|
},
|
|
"ScanStatusDescription":{"type":"string"},
|
|
"ScanTimestamp":{"type":"timestamp"},
|
|
"ScanType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"BASIC",
|
|
"ENHANCED"
|
|
]
|
|
},
|
|
"ScanningConfigurationFailureCode":{
|
|
"type":"string",
|
|
"enum":["REPOSITORY_NOT_FOUND"]
|
|
},
|
|
"ScanningConfigurationFailureReason":{"type":"string"},
|
|
"ScanningConfigurationRepositoryNameList":{
|
|
"type":"list",
|
|
"member":{"shape":"RepositoryName"},
|
|
"max":25,
|
|
"min":1
|
|
},
|
|
"ScanningRepositoryFilter":{
|
|
"type":"structure",
|
|
"required":[
|
|
"filter",
|
|
"filterType"
|
|
],
|
|
"members":{
|
|
"filter":{
|
|
"shape":"ScanningRepositoryFilterValue",
|
|
"documentation":"<p>The filter to use when scanning.</p>"
|
|
},
|
|
"filterType":{
|
|
"shape":"ScanningRepositoryFilterType",
|
|
"documentation":"<p>The type associated with the filter.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The details of a scanning repository filter. For more information on how to use filters, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters\">Using filters</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"ScanningRepositoryFilterList":{
|
|
"type":"list",
|
|
"member":{"shape":"ScanningRepositoryFilter"},
|
|
"max":100,
|
|
"min":0
|
|
},
|
|
"ScanningRepositoryFilterType":{
|
|
"type":"string",
|
|
"enum":["WILDCARD"]
|
|
},
|
|
"ScanningRepositoryFilterValue":{
|
|
"type":"string",
|
|
"max":255,
|
|
"min":1,
|
|
"pattern":"^[a-z0-9*](?:[._\\-/a-z0-9*]?[a-z0-9*]+)*$"
|
|
},
|
|
"Score":{"type":"double"},
|
|
"ScoreDetails":{
|
|
"type":"structure",
|
|
"members":{
|
|
"cvss":{
|
|
"shape":"CvssScoreDetails",
|
|
"documentation":"<p>An object that contains details about the CVSS score given to a finding.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information about the Amazon Inspector score given to a finding.</p>"
|
|
},
|
|
"ScoringVector":{"type":"string"},
|
|
"ServerException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>These errors are usually caused by a server-side issue.</p>",
|
|
"exception":true,
|
|
"fault":true
|
|
},
|
|
"SetRepositoryPolicyRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"policyText"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to receive the policy.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RepositoryPolicyText",
|
|
"documentation":"<p>The JSON repository policy text to apply to the repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html\">Amazon ECR repository policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
|
|
},
|
|
"force":{
|
|
"shape":"ForceFlag",
|
|
"documentation":"<p>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 <a>SetRepositoryPolicy</a> operation. This is intended to prevent accidental repository lock outs.</p>"
|
|
}
|
|
}
|
|
},
|
|
"SetRepositoryPolicyResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"policyText":{
|
|
"shape":"RepositoryPolicyText",
|
|
"documentation":"<p>The JSON repository policy text applied to the repository.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Severity":{"type":"string"},
|
|
"SeverityCount":{
|
|
"type":"integer",
|
|
"min":0
|
|
},
|
|
"Source":{"type":"string"},
|
|
"SourceLayerHash":{"type":"string"},
|
|
"StartImageScanRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"repositoryName",
|
|
"imageId"
|
|
],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository that contains the images to scan.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"}
|
|
}
|
|
},
|
|
"StartImageScanResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"imageId":{"shape":"ImageIdentifier"},
|
|
"imageScanStatus":{
|
|
"shape":"ImageScanStatus",
|
|
"documentation":"<p>The current state of the scan.</p>"
|
|
}
|
|
}
|
|
},
|
|
"StartLifecyclePolicyPreviewRequest":{
|
|
"type":"structure",
|
|
"required":["repositoryName"],
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to be evaluated.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.</p>"
|
|
}
|
|
}
|
|
},
|
|
"StartLifecyclePolicyPreviewResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"lifecyclePolicyText":{
|
|
"shape":"LifecyclePolicyText",
|
|
"documentation":"<p>The JSON repository policy text.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"LifecyclePolicyPreviewStatus",
|
|
"documentation":"<p>The status of the lifecycle policy preview request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Status":{"type":"string"},
|
|
"Tag":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Key":{
|
|
"shape":"TagKey",
|
|
"documentation":"<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label that acts like a category for more specific tag values.</p>"
|
|
},
|
|
"Value":{
|
|
"shape":"TagValue",
|
|
"documentation":"<p>A <code>value</code> acts as a descriptor within a tag category (key).</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The metadata to apply to a resource to help you categorize and organize them. Each tag consists of a key and a 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.</p>"
|
|
},
|
|
"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":"<p>The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagList",
|
|
"documentation":"<p>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.</p>"
|
|
}
|
|
}
|
|
},
|
|
"TagResourceResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"TagStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"TAGGED",
|
|
"UNTAGGED",
|
|
"ANY"
|
|
]
|
|
},
|
|
"TagValue":{"type":"string"},
|
|
"Tags":{
|
|
"type":"map",
|
|
"key":{"shape":"TagKey"},
|
|
"value":{"shape":"TagValue"}
|
|
},
|
|
"Title":{"type":"string"},
|
|
"TooManyTagsException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.</p>",
|
|
"exception":true
|
|
},
|
|
"Type":{"type":"string"},
|
|
"UnsupportedImageTypeException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The image is of a type that cannot be scanned.</p>",
|
|
"exception":true
|
|
},
|
|
"UnsupportedUpstreamRegistryException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>The specified upstream registry isn't supported.</p>",
|
|
"exception":true
|
|
},
|
|
"UntagResourceRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"resourceArn",
|
|
"tagKeys"
|
|
],
|
|
"members":{
|
|
"resourceArn":{
|
|
"shape":"Arn",
|
|
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.</p>"
|
|
},
|
|
"tagKeys":{
|
|
"shape":"TagKeyList",
|
|
"documentation":"<p>The keys of the tags to be removed.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>The Amazon Web Services 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.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The name of the repository to which you are uploading layer parts.</p>"
|
|
},
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID from a previous <a>InitiateLayerUpload</a> operation to associate with the layer part upload.</p>"
|
|
},
|
|
"partFirstByte":{
|
|
"shape":"PartSize",
|
|
"documentation":"<p>The position of the first byte of the layer part witin the overall image layer.</p>"
|
|
},
|
|
"partLastByte":{
|
|
"shape":"PartSize",
|
|
"documentation":"<p>The position of the last byte of the layer part within the overall image layer.</p>"
|
|
},
|
|
"layerPartBlob":{
|
|
"shape":"LayerPartBlob",
|
|
"documentation":"<p>The base64-encoded layer part payload.</p>"
|
|
}
|
|
}
|
|
},
|
|
"UploadLayerPartResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"registryId":{
|
|
"shape":"RegistryId",
|
|
"documentation":"<p>The registry ID associated with the request.</p>"
|
|
},
|
|
"repositoryName":{
|
|
"shape":"RepositoryName",
|
|
"documentation":"<p>The repository name associated with the request.</p>"
|
|
},
|
|
"uploadId":{
|
|
"shape":"UploadId",
|
|
"documentation":"<p>The upload ID associated with the request.</p>"
|
|
},
|
|
"lastByteReceived":{
|
|
"shape":"PartSize",
|
|
"documentation":"<p>The integer value of the last byte received in the request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"UploadNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"ExceptionMessage",
|
|
"documentation":"<p>The error message associated with the exception.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The upload could not be found, or the specified upload ID is not valid for this repository.</p>",
|
|
"exception":true
|
|
},
|
|
"Url":{"type":"string"},
|
|
"ValidationException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>There was an exception validating this request.</p>",
|
|
"exception":true
|
|
},
|
|
"Version":{"type":"string"},
|
|
"VulnerabilityId":{"type":"string"},
|
|
"VulnerabilitySourceUpdateTimestamp":{"type":"timestamp"},
|
|
"VulnerablePackage":{
|
|
"type":"structure",
|
|
"members":{
|
|
"arch":{
|
|
"shape":"Arch",
|
|
"documentation":"<p>The architecture of the vulnerable package.</p>"
|
|
},
|
|
"epoch":{
|
|
"shape":"Epoch",
|
|
"documentation":"<p>The epoch of the vulnerable package.</p>"
|
|
},
|
|
"filePath":{
|
|
"shape":"FilePath",
|
|
"documentation":"<p>The file path of the vulnerable package.</p>"
|
|
},
|
|
"name":{
|
|
"shape":"VulnerablePackageName",
|
|
"documentation":"<p>The name of the vulnerable package.</p>"
|
|
},
|
|
"packageManager":{
|
|
"shape":"PackageManager",
|
|
"documentation":"<p>The package manager of the vulnerable package.</p>"
|
|
},
|
|
"release":{
|
|
"shape":"Release",
|
|
"documentation":"<p>The release of the vulnerable package.</p>"
|
|
},
|
|
"sourceLayerHash":{
|
|
"shape":"SourceLayerHash",
|
|
"documentation":"<p>The source layer hash of the vulnerable package.</p>"
|
|
},
|
|
"version":{
|
|
"shape":"Version",
|
|
"documentation":"<p>The version of the vulnerable package.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information on the vulnerable package identified by a finding.</p>"
|
|
},
|
|
"VulnerablePackageName":{"type":"string"},
|
|
"VulnerablePackagesList":{
|
|
"type":"list",
|
|
"member":{"shape":"VulnerablePackage"}
|
|
}
|
|
},
|
|
"documentation":"<fullname>Amazon Elastic Container Registry</fullname> <p>Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.</p> <p>Amazon ECR has service endpoints in each supported Region. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ecr.html\">Amazon ECR endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
|
}
|