{
"smithy": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.ecr#AccountSettingName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 64
}
}
},
"com.amazonaws.ecr#AccountSettingValue": {
"type": "string"
},
"com.amazonaws.ecr#AmazonEC2ContainerRegistry_V20150921": {
"type": "service",
"version": "2015-09-21",
"operations": [
{
"target": "com.amazonaws.ecr#BatchCheckLayerAvailability"
},
{
"target": "com.amazonaws.ecr#BatchDeleteImage"
},
{
"target": "com.amazonaws.ecr#BatchGetImage"
},
{
"target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration"
},
{
"target": "com.amazonaws.ecr#CompleteLayerUpload"
},
{
"target": "com.amazonaws.ecr#CreatePullThroughCacheRule"
},
{
"target": "com.amazonaws.ecr#CreateRepository"
},
{
"target": "com.amazonaws.ecr#CreateRepositoryCreationTemplate"
},
{
"target": "com.amazonaws.ecr#DeleteLifecyclePolicy"
},
{
"target": "com.amazonaws.ecr#DeletePullThroughCacheRule"
},
{
"target": "com.amazonaws.ecr#DeleteRegistryPolicy"
},
{
"target": "com.amazonaws.ecr#DeleteRepository"
},
{
"target": "com.amazonaws.ecr#DeleteRepositoryCreationTemplate"
},
{
"target": "com.amazonaws.ecr#DeleteRepositoryPolicy"
},
{
"target": "com.amazonaws.ecr#DeleteSigningConfiguration"
},
{
"target": "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusion"
},
{
"target": "com.amazonaws.ecr#DescribeImageReplicationStatus"
},
{
"target": "com.amazonaws.ecr#DescribeImages"
},
{
"target": "com.amazonaws.ecr#DescribeImageScanFindings"
},
{
"target": "com.amazonaws.ecr#DescribeImageSigningStatus"
},
{
"target": "com.amazonaws.ecr#DescribePullThroughCacheRules"
},
{
"target": "com.amazonaws.ecr#DescribeRegistry"
},
{
"target": "com.amazonaws.ecr#DescribeReplicationBackfillResults"
},
{
"target": "com.amazonaws.ecr#DescribeRepositories"
},
{
"target": "com.amazonaws.ecr#DescribeRepositoryCreationTemplates"
},
{
"target": "com.amazonaws.ecr#GetAccountSetting"
},
{
"target": "com.amazonaws.ecr#GetAuthorizationToken"
},
{
"target": "com.amazonaws.ecr#GetDownloadUrlForLayer"
},
{
"target": "com.amazonaws.ecr#GetLifecyclePolicy"
},
{
"target": "com.amazonaws.ecr#GetLifecyclePolicyPreview"
},
{
"target": "com.amazonaws.ecr#GetRegistryPolicy"
},
{
"target": "com.amazonaws.ecr#GetRegistryScanningConfiguration"
},
{
"target": "com.amazonaws.ecr#GetRepositoryPolicy"
},
{
"target": "com.amazonaws.ecr#GetSigningConfiguration"
},
{
"target": "com.amazonaws.ecr#InitiateLayerUpload"
},
{
"target": "com.amazonaws.ecr#ListImageReferrers"
},
{
"target": "com.amazonaws.ecr#ListImages"
},
{
"target": "com.amazonaws.ecr#ListPullTimeUpdateExclusions"
},
{
"target": "com.amazonaws.ecr#ListReplicationBackfills"
},
{
"target": "com.amazonaws.ecr#ListTagsForResource"
},
{
"target": "com.amazonaws.ecr#PutAccountSetting"
},
{
"target": "com.amazonaws.ecr#PutImage"
},
{
"target": "com.amazonaws.ecr#PutImageScanningConfiguration"
},
{
"target": "com.amazonaws.ecr#PutImageTagMutability"
},
{
"target": "com.amazonaws.ecr#PutLifecyclePolicy"
},
{
"target": "com.amazonaws.ecr#PutRegistryPolicy"
},
{
"target": "com.amazonaws.ecr#PutRegistryScanningConfiguration"
},
{
"target": "com.amazonaws.ecr#PutReplicationConfiguration"
},
{
"target": "com.amazonaws.ecr#PutSigningConfiguration"
},
{
"target": "com.amazonaws.ecr#RegisterPullTimeUpdateExclusion"
},
{
"target": "com.amazonaws.ecr#SetRepositoryPolicy"
},
{
"target": "com.amazonaws.ecr#StartImageScan"
},
{
"target": "com.amazonaws.ecr#StartLifecyclePolicyPreview"
},
{
"target": "com.amazonaws.ecr#StartReplicationBackfill"
},
{
"target": "com.amazonaws.ecr#StopReplicationBackfill"
},
{
"target": "com.amazonaws.ecr#TagResource"
},
{
"target": "com.amazonaws.ecr#UntagResource"
},
{
"target": "com.amazonaws.ecr#UpdateImageStorageClass"
},
{
"target": "com.amazonaws.ecr#UpdatePullThroughCacheRule"
},
{
"target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplate"
},
{
"target": "com.amazonaws.ecr#UploadLayerPart"
},
{
"target": "com.amazonaws.ecr#ValidatePullThroughCacheRule"
}
],
"traits": {
"aws.api#service": {
"sdkId": "ECR",
"arnNamespace": "ecr",
"cloudFormationName": "ECR",
"cloudTrailEventSource": "ecr.amazonaws.com",
"endpointPrefix": "api.ecr"
},
"aws.auth#sigv4": {
"name": "ecr"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the\n familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR\n provides a secure, scalable, and reliable registry for your Docker or Open Container\n Initiative (OCI) images. Amazon ECR supports private repositories with resource-based\n permissions using IAM so that specific users or Amazon EC2 instances can access\n repositories and images.
\nAmazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the\n Amazon Web Services General Reference.
", "smithy.api#title": "Amazon Elastic Container Registry", "smithy.api#xmlNamespace": { "uri": "http://ecr.amazonaws.com/doc/2015-09-21/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 24, "nodes": "/////wAAAAH/////AAAAAAAAABcAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAABQAAAAGAAAABAAAABQAAAAHAAAABQAAABQAAAAIAAAABgAAABQAAAAJAAAABwAAABQAAAAKAAAACAAAABQAAAALAAAACQAAABQAAAAMAAAACgAAABQAAAANAAAACwAAABAAAAAOAAAADQAAAA8F9eEEAAAADgX14QsF9eEMAAAADAAAABIAAAARAAAADQX14QkF9eEKAAAADQAAABMF9eEGAAAADgX14QgF9eEJAAAACwAAABYAAAAVAAAADQX14QUF9eEEAAAADQX14QcF9eEGAAAACwX14QEAAAAYAAAADQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.ecr-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://api.ecr.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://ecr.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.ecr.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.ecr#Annotations": { "type": "map", "key": { "target": "com.amazonaws.ecr#String" }, "value": { "target": "com.amazonaws.ecr#String" } }, "com.amazonaws.ecr#Arch": { "type": "string" }, "com.amazonaws.ecr#Arn": { "type": "string" }, "com.amazonaws.ecr#ArtifactStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "ACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING" } } } }, "com.amazonaws.ecr#ArtifactStatusFilter": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "ACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.ecr#ArtifactType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.ecr#ArtifactTypeList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ArtifactType" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.ecr#Attribute": { "type": "structure", "members": { "key": { "target": "com.amazonaws.ecr#AttributeKey", "traits": { "smithy.api#documentation": "The attribute key.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.ecr#AttributeValue", "traits": { "smithy.api#documentation": "The value assigned to the attribute key.
" } } }, "traits": { "smithy.api#documentation": "This data type is used in the ImageScanFinding data type.
" } }, "com.amazonaws.ecr#AttributeKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.ecr#AttributeList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Attribute" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.ecr#AttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.ecr#Author": { "type": "string" }, "com.amazonaws.ecr#AuthorizationData": { "type": "structure", "members": { "authorizationToken": { "target": "com.amazonaws.ecr#Base64", "traits": { "smithy.api#documentation": "A base64-encoded string that contains authorization data for the specified Amazon ECR\n registry. When the string is decoded, it is presented in the format\n user:password for private registry authentication using docker\n login.
The Unix time in seconds and milliseconds when the authorization token expires.\n Authorization tokens are valid for 12 hours.
" } }, "proxyEndpoint": { "target": "com.amazonaws.ecr#ProxyEndpoint", "traits": { "smithy.api#documentation": "The registry URL to use for this authorization token in a docker login\n command. The Amazon ECR registry URL format is\n https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,\n https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
An object representing authorization data for an Amazon ECR registry.
" } }, "com.amazonaws.ecr#AuthorizationDataList": { "type": "list", "member": { "target": "com.amazonaws.ecr#AuthorizationData" } }, "com.amazonaws.ecr#AwsEcrContainerImageDetails": { "type": "structure", "members": { "architecture": { "target": "com.amazonaws.ecr#Arch", "traits": { "smithy.api#documentation": "The architecture of the Amazon ECR container image.
" } }, "author": { "target": "com.amazonaws.ecr#Author", "traits": { "smithy.api#documentation": "The image author of the Amazon ECR container image.
" } }, "imageHash": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The image hash of the Amazon ECR container image.
" } }, "imageTags": { "target": "com.amazonaws.ecr#ImageTagsList", "traits": { "smithy.api#documentation": "The image tags attached to the Amazon ECR container image.
" } }, "platform": { "target": "com.amazonaws.ecr#Platform", "traits": { "smithy.api#documentation": "The platform of the Amazon ECR container image.
" } }, "pushedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time the Amazon ECR container image was pushed.
" } }, "lastInUseAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The most recent date and time a cluster was running the image.
" } }, "inUseCount": { "target": "com.amazonaws.ecr#InUseCount", "traits": { "smithy.api#documentation": "The number of Amazon ECS or Amazon EKS clusters currently running the\n image.
" } }, "registry": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry the Amazon ECR container image belongs to.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository the Amazon ECR container image resides in.
" } } }, "traits": { "smithy.api#documentation": "The image details of the Amazon ECR container image.
" } }, "com.amazonaws.ecr#Base64": { "type": "string", "traits": { "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.ecr#BaseScore": { "type": "double", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.ecr#BatchCheckLayerAvailability": { "type": "operation", "input": { "target": "com.amazonaws.ecr#BatchCheckLayerAvailabilityRequest" }, "output": { "target": "com.amazonaws.ecr#BatchCheckLayerAvailabilityResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Checks the availability of one or more image layers in a repository.
\nWhen an image is pushed to a repository, each image layer is checked to verify if it\n has been uploaded before. If it has been uploaded, then the image layer is\n skipped.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry that contains the image layers to\n check. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that is associated with the image layers to check.
", "smithy.api#required": {} } }, "layerDigests": { "target": "com.amazonaws.ecr#BatchedOperationLayerDigestList", "traits": { "smithy.api#documentation": "The digests of the image layers to check.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#BatchCheckLayerAvailabilityResponse": { "type": "structure", "members": { "layers": { "target": "com.amazonaws.ecr#LayerList", "traits": { "smithy.api#documentation": "A list of image layer objects corresponding to the image layer references in the\n request.
" } }, "failures": { "target": "com.amazonaws.ecr#LayerFailureList", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#BatchDeleteImage": { "type": "operation", "input": { "target": "com.amazonaws.ecr#BatchDeleteImageRequest" }, "output": { "target": "com.amazonaws.ecr#BatchDeleteImageResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes a list of specified images within a repository. Images are specified with\n either an imageTag or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When\n you remove the last tag from an image, the image is deleted from your repository.
\nYou can completely delete an image (and all of its tags) by specifying the image's\n digest in your request.
", "smithy.api#examples": [ { "title": "To delete multiple images", "documentation": "This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.", "input": { "repositoryName": "ubuntu", "imageIds": [ { "imageTag": "precise" }, { "imageTag": "trusty" } ] }, "output": { "failures": [], "imageIds": [ { "imageTag": "precise", "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f" } ] } } ] } }, "com.amazonaws.ecr#BatchDeleteImageRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the image to delete.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository that contains the image to delete.
", "smithy.api#required": {} } }, "imageIds": { "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { "smithy.api#documentation": "A list of image ID references that correspond to images to delete. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.
Deletes specified images within a specified repository. Images are specified with\n either the imageTag or imageDigest.
The image IDs of the deleted images.
" } }, "failures": { "target": "com.amazonaws.ecr#ImageFailureList", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#BatchGetImage": { "type": "operation", "input": { "target": "com.amazonaws.ecr#BatchGetImageRequest" }, "output": { "target": "com.amazonaws.ecr#BatchGetImageResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#UnableToGetUpstreamImageException" } ], "traits": { "smithy.api#documentation": "Gets detailed information for an image. Images are specified with either an\n imageTag or imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image\n manifest.
", "smithy.api#examples": [ { "title": "To obtain multiple images in a single request", "documentation": "This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.", "input": { "repositoryName": "ubuntu", "imageIds": [ { "imageTag": "precise" } ] }, "output": { "images": [ { "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...", "repositoryName": "ubuntu", "registryId": "244698725403", "imageId": { "imageTag": "precise", "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a" } } ], "failures": [] } } ] } }, "com.amazonaws.ecr#BatchGetImageRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the images to\n describe. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository that contains the images to describe.
", "smithy.api#required": {} } }, "imageIds": { "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { "smithy.api#documentation": "A list of image ID references that correspond to images to describe. The format of the\n imageIds reference is imageTag=tag or\n imageDigest=digest.
The accepted media types for the request.
\nValid values: application/vnd.docker.distribution.manifest.v1+json |\n application/vnd.docker.distribution.manifest.v2+json |\n application/vnd.oci.image.manifest.v1+json\n
A list of image objects corresponding to the image references in the request.
" } }, "failures": { "target": "com.amazonaws.ecr#ImageFailureList", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#BatchGetRepositoryScanningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets the scanning configuration for one or more repositories.
" } }, "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationRequest": { "type": "structure", "members": { "repositoryNames": { "target": "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList", "traits": { "smithy.api#documentation": "One or more repository names to get the scanning configuration for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#BatchGetRepositoryScanningConfigurationResponse": { "type": "structure", "members": { "scanningConfigurations": { "target": "com.amazonaws.ecr#RepositoryScanningConfigurationList", "traits": { "smithy.api#documentation": "The scanning configuration for the requested repositories.
" } }, "failures": { "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#BatchedOperationLayerDigest": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 } } }, "com.amazonaws.ecr#BatchedOperationLayerDigestList": { "type": "list", "member": { "target": "com.amazonaws.ecr#BatchedOperationLayerDigest" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#BlockedByOrganizationPolicyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The operation did not succeed because the account is managed by a organization policy.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#CompleteLayerUpload": { "type": "operation", "input": { "target": "com.amazonaws.ecr#CompleteLayerUploadRequest" }, "output": { "target": "com.amazonaws.ecr#CompleteLayerUploadResponse" }, "errors": [ { "target": "com.amazonaws.ecr#EmptyUploadException" }, { "target": "com.amazonaws.ecr#InvalidLayerException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#LayerAlreadyExistsException" }, { "target": "com.amazonaws.ecr#LayerPartTooSmallException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#UploadNotFoundException" } ], "traits": { "smithy.api#documentation": "Informs Amazon ECR that the image layer upload has completed for a specified registry,\n repository name, and upload ID. You can optionally provide a sha256 digest\n of the image layer for data validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image\n layer to verify that the upload has completed.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry to which to upload layers.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to associate with the image layer.
", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID from a previous InitiateLayerUpload operation to\n associate with the image layer.
", "smithy.api#required": {} } }, "layerDigests": { "target": "com.amazonaws.ecr#LayerDigestList", "traits": { "smithy.api#documentation": "The sha256 digest of the image layer.
The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID associated with the layer.
" } }, "layerDigest": { "target": "com.amazonaws.ecr#LayerDigest", "traits": { "smithy.api#documentation": "The sha256 digest of the image layer.
Creates a pull through cache rule. A pull through cache rule provides a way to cache\n images from an upstream registry source in your Amazon ECR private registry. For more\n information, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#CreatePullThroughCacheRuleRequest": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The repository name prefix to use when caching images from the source registry.
\nThere is always an assumed / applied to the end of the prefix. If you\n specify ecr-public as the prefix, Amazon ECR treats that as\n ecr-public/.
The registry URL of the upstream public registry to use as the source for the pull\n through cache rule. The following is the syntax to use for each supported upstream\n registry.
\nAmazon ECR (ecr) \u2013\n \n
Amazon ECR Public (ecr-public) \u2013 public.ecr.aws\n
Docker Hub (docker-hub) \u2013\n registry-1.docker.io\n
GitHub Container Registry (github-container-registry) \u2013\n ghcr.io\n
GitLab Container Registry (gitlab-container-registry) \u2013\n registry.gitlab.com\n
Kubernetes (k8s) \u2013 registry.k8s.io\n
Microsoft Azure Container Registry (azure-container-registry) \u2013\n \n
Quay (quay) \u2013 quay.io\n
The Amazon Web Services account ID associated with the registry to create the pull through cache\n rule for. If you do not specify a registry, the default registry is assumed.
" } }, "upstreamRegistry": { "target": "com.amazonaws.ecr#UpstreamRegistry", "traits": { "smithy.api#documentation": "The name of the upstream registry.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to\n the ECR upstream registry. This role must be in the same account as the registry that\n you are configuring.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The repository name prefix of the upstream registry to match with the upstream\n repository name. When this field isn't specified, Amazon ECR will use the\n ROOT.
The Amazon ECR repository prefix associated with the pull through cache rule.
" } }, "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" } }, "createdAt": { "target": "com.amazonaws.ecr#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the pull through cache rule was\n created.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "upstreamRegistry": { "target": "com.amazonaws.ecr#UpstreamRegistry", "traits": { "smithy.api#documentation": "The name of the upstream registry associated with the pull through cache rule.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the pull through cache rule.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The upstream repository prefix associated with the pull through cache rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#CreateRepository": { "type": "operation", "input": { "target": "com.amazonaws.ecr#CreateRepositoryRequest" }, "output": { "target": "com.amazonaws.ecr#CreateRepositoryResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#InvalidTagParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#RepositoryAlreadyExistsException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Creates a repository. For more information, see Amazon ECR repositories in the\n Amazon Elastic Container Registry User Guide.
", "smithy.api#examples": [ { "title": "To create a new repository", "documentation": "This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.", "input": { "repositoryName": "project-a/nginx-web-app" }, "output": { "repository": { "registryId": "012345678901", "repositoryName": "project-a/nginx-web-app", "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app" } } } ] } }, "com.amazonaws.ecr#CreateRepositoryCreationTemplate": { "type": "operation", "input": { "target": "com.amazonaws.ecr#CreateRepositoryCreationTemplateRequest" }, "output": { "target": "com.amazonaws.ecr#CreateRepositoryCreationTemplateResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#TemplateAlreadyExistsException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a repository creation template. This template is used to define the settings\n for repositories created by Amazon ECR on your behalf. For example, repositories created\n through pull through cache actions. For more information, see Private\n repository creation templates in the\n Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#CreateRepositoryCreationTemplateRequest": { "type": "structure", "members": { "prefix": { "target": "com.amazonaws.ecr#Prefix", "traits": { "smithy.api#documentation": "The repository namespace prefix to associate with the template. All repositories\n created using this namespace prefix will have the settings defined in this template\n applied. For example, a prefix of prod would apply to all repositories\n beginning with prod/. Similarly, a prefix of prod/team would\n apply to all repositories beginning with prod/team/.
To apply a template to all repositories in your registry that don't have an associated\n creation template, you can use ROOT as the prefix.
There is always an assumed / applied to the end of the prefix. If you\n specify ecr-public as the prefix, Amazon ECR treats that as\n ecr-public/. When using a pull through cache rule, the repository\n prefix you specify during rule creation is what you should specify as your\n repository creation template prefix as well.
A description for the repository creation template.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The encryption configuration to use for repositories created using the\n template.
" } }, "resourceTags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The metadata to apply to the repository to help you categorize and organize. Each tag\n 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\n a maximum length of 256 characters.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.
A list of filters that specify which image tags should be excluded from the repository\n creation template's image tag mutability setting.
" } }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The repository policy to apply to repositories created using the template. A\n repository policy is a permissions policy associated with a repository to control access\n permissions.
" } }, "lifecyclePolicy": { "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The lifecycle policy to use for repositories created using the template.
" } }, "appliedFor": { "target": "com.amazonaws.ecr#RCTAppliedForList", "traits": { "smithy.api#documentation": "A list of enumerable strings representing the Amazon ECR repository creation scenarios that\n this template will apply towards. The supported scenarios are\n PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH\n
The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as\n the registry that you are configuring. Amazon ECR will assume your supplied role when the\n customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#CreateRepositoryCreationTemplateResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryCreationTemplate": { "target": "com.amazonaws.ecr#RepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The details of the repository creation template associated with the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#CreateRepositoryRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to create the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name to use for the repository. The repository name may be specified on its own\n (such as nginx-web-app) or it can be prepended with a namespace to group\n the repository into a category (such as project-a/nginx-web-app).
The repository name must start with a letter and can only contain lowercase letters,\n numbers, hyphens, underscores, and forward slashes.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The metadata that you apply to the repository to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.
A list of filters that specify which image tags should be excluded from the\n repository's image tag mutability setting.
" } }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "The imageScanningConfiguration parameter is being deprecated, in\n favor of specifying the image scanning configuration at the registry level. For more\n information, see PutRegistryScanningConfiguration.
The image scanning configuration for the repository. This determines whether images\n are scanned for known vulnerabilities after being pushed to the repository.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.ecr#EncryptionConfiguration", "traits": { "smithy.api#documentation": "The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#CreateRepositoryResponse": { "type": "structure", "members": { "repository": { "target": "com.amazonaws.ecr#Repository", "traits": { "smithy.api#documentation": "The repository that was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#CreationTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#CredentialArn": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 612 }, "smithy.api#pattern": "^arn:aws(-\\w+)*:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\\-pullthroughcache\\/[a-zA-Z0-9\\/_+=.@-]+$" } }, "com.amazonaws.ecr#CustomRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.ecr#CvssScore": { "type": "structure", "members": { "baseScore": { "target": "com.amazonaws.ecr#BaseScore", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The base CVSS score used for the finding.
" } }, "scoringVector": { "target": "com.amazonaws.ecr#ScoringVector", "traits": { "smithy.api#documentation": "The vector string of the CVSS score.
" } }, "source": { "target": "com.amazonaws.ecr#Source", "traits": { "smithy.api#documentation": "The source of the CVSS score.
" } }, "version": { "target": "com.amazonaws.ecr#Version", "traits": { "smithy.api#documentation": "The version of CVSS used for the score.
" } } }, "traits": { "smithy.api#documentation": "The CVSS score for a finding.
" } }, "com.amazonaws.ecr#CvssScoreAdjustment": { "type": "structure", "members": { "metric": { "target": "com.amazonaws.ecr#Metric", "traits": { "smithy.api#documentation": "The metric used to adjust the CVSS score.
" } }, "reason": { "target": "com.amazonaws.ecr#Reason", "traits": { "smithy.api#documentation": "The reason the CVSS score has been adjustment.
" } } }, "traits": { "smithy.api#documentation": "Details on adjustments Amazon Inspector made to the CVSS score for a finding.
" } }, "com.amazonaws.ecr#CvssScoreAdjustmentList": { "type": "list", "member": { "target": "com.amazonaws.ecr#CvssScoreAdjustment" } }, "com.amazonaws.ecr#CvssScoreDetails": { "type": "structure", "members": { "adjustments": { "target": "com.amazonaws.ecr#CvssScoreAdjustmentList", "traits": { "smithy.api#documentation": "An object that contains details about adjustment Amazon Inspector made to the CVSS score.
" } }, "score": { "target": "com.amazonaws.ecr#Score", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The CVSS score.
" } }, "scoreSource": { "target": "com.amazonaws.ecr#Source", "traits": { "smithy.api#documentation": "The source for the CVSS score.
" } }, "scoringVector": { "target": "com.amazonaws.ecr#ScoringVector", "traits": { "smithy.api#documentation": "The vector for the CVSS score.
" } }, "version": { "target": "com.amazonaws.ecr#Version", "traits": { "smithy.api#documentation": "The CVSS version used in scoring.
" } } }, "traits": { "smithy.api#documentation": "Information about the CVSS score.
" } }, "com.amazonaws.ecr#CvssScoreList": { "type": "list", "member": { "target": "com.amazonaws.ecr#CvssScore" } }, "com.amazonaws.ecr#Date": { "type": "timestamp" }, "com.amazonaws.ecr#DeleteLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeleteLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.ecr#DeleteLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the lifecycle policy associated with the specified repository.
" } }, "com.amazonaws.ecr#DeleteLifecyclePolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeleteLifecyclePolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON lifecycle policy text.
" } }, "lastEvaluatedAt": { "target": "com.amazonaws.ecr#EvaluationTimestamp", "traits": { "smithy.api#documentation": "The time stamp of the last time that the lifecycle policy was run.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeletePullThroughCacheRule": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest" }, "output": { "target": "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a pull through cache rule.
" } }, "com.amazonaws.ecr#DeletePullThroughCacheRuleRequest": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule to\n delete.
", "smithy.api#required": {} } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the pull through cache\n rule. If you do not specify a registry, the default registry is assumed.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeletePullThroughCacheRuleResponse": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefix associated with the request.
" } }, "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" } }, "createdAt": { "target": "com.amazonaws.ecr#CreationTimestamp", "traits": { "smithy.api#documentation": "The timestamp associated with the pull through cache rule.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the pull through cache rule.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The upstream repository prefix associated with the pull through cache rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeleteRegistryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeleteRegistryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#DeleteRegistryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RegistryPolicyNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the registry permissions policy.
" } }, "com.amazonaws.ecr#DeleteRegistryPolicyRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeleteRegistryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RegistryPolicyText", "traits": { "smithy.api#documentation": "The contents of the registry permissions policy that was deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeleteReplication": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.ecr#DeleteReplicationFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Specifies whether delete replication is enabled. If set to true, the\n service replicates image deletions and image tag removals from the source registry to\n each replication destination. If set to false, the service does not\n replicate image deletions or image tag removals.
The delete replication configuration for a replication rule. When delete replication\n is enabled, the service replicates image deletions and image tag removals in the source\n registry to the replication destinations.
" } }, "com.amazonaws.ecr#DeleteReplicationFlag": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.ecr#DeleteRepository": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeleteRepositoryRequest" }, "output": { "target": "com.amazonaws.ecr#DeleteRepositoryResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#RepositoryNotEmptyException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes a repository. If the repository isn't empty, you must either delete the\n contents of the repository or use the force option to delete the repository\n and have Amazon ECR delete all of its contents on your behalf.
Deletes a repository creation template.
" } }, "com.amazonaws.ecr#DeleteRepositoryCreationTemplateRequest": { "type": "structure", "members": { "prefix": { "target": "com.amazonaws.ecr#Prefix", "traits": { "smithy.api#documentation": "The repository namespace prefix associated with the repository creation\n template.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeleteRepositoryCreationTemplateResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryCreationTemplate": { "target": "com.amazonaws.ecr#RepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The details of the repository creation template that was deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeleteRepositoryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeleteRepositoryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#DeleteRepositoryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryPolicyNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Deletes the repository policy associated with the specified repository.
", "smithy.api#examples": [ { "title": "To delete the policy associated with a repository", "documentation": "This example deletes the policy associated with the repository named ubuntu in the current account.", "input": { "repositoryName": "ubuntu" }, "output": { "policyText": "{ ... }", "repositoryName": "ubuntu", "registryId": "012345678901" } } ] } }, "com.amazonaws.ecr#DeleteRepositoryPolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository policy\n to delete. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that is associated with the repository policy to\n delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeleteRepositoryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy that was deleted from the repository.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeleteRepositoryRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository to\n delete. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to delete.
", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.ecr#ForceFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If true, deleting the repository force deletes the contents of the repository. If\n false, the repository must be empty before attempting to delete it.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeleteRepositoryResponse": { "type": "structure", "members": { "repository": { "target": "com.amazonaws.ecr#Repository", "traits": { "smithy.api#documentation": "The repository that was deleted.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeleteSigningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeleteSigningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#DeleteSigningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#SigningConfigurationNotFoundException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes the registry's signing configuration. Images pushed after deletion of the signing\n configuration will no longer be automatically signed.
\nFor more information, see Managed signing in the\n Amazon Elastic Container Registry User Guide.
\nDeleting the signing configuration does not affect existing image signatures.
\nThe Amazon Web Services account ID associated with the registry.
" } }, "signingConfiguration": { "target": "com.amazonaws.ecr#SigningConfiguration", "traits": { "smithy.api#documentation": "The registry's deleted signing configuration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusion": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusionRequest" }, "output": { "target": "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusionResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ExclusionNotFoundException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a principal from the pull time update exclusion list for a registry. Once removed, Amazon ECR will resume updating the pull time if the specified principal pulls an image.
", "smithy.api#examples": [ { "title": "To remove a principal from the pull time exclusion list", "documentation": "This example removes an IAM role from the pull time update exclusion list. Amazon ECR will resume recording image pull timestamps for this principal.", "input": { "principalArn": "arn:aws:iam::012345678910:role/ECRAccess" }, "output": { "principalArn": "arn:aws:iam::012345678910:role/ECRAccess" } } ] } }, "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusionRequest": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.ecr#PrincipalArn", "traits": { "smithy.api#documentation": "The ARN of the IAM principal to remove from the pull time update exclusion list.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DeregisterPullTimeUpdateExclusionResponse": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.ecr#PrincipalArn", "traits": { "smithy.api#documentation": "The ARN of the IAM principal that was removed from the pull time update exclusion list.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DescribeImageReplicationStatus": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DescribeImageReplicationStatusRequest" }, "output": { "target": "com.amazonaws.ecr#DescribeImageReplicationStatusResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ImageNotFoundException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the replication status for a specified image.
" } }, "com.amazonaws.ecr#DescribeImageReplicationStatusRequest": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that the image is in.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#required": {} } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DescribeImageReplicationStatusResponse": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier" }, "replicationStatuses": { "target": "com.amazonaws.ecr#ImageReplicationStatusList", "traits": { "smithy.api#documentation": "The replication status details for the images in the specified repository.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DescribeImageScanFindings": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DescribeImageScanFindingsRequest" }, "output": { "target": "com.amazonaws.ecr#DescribeImageScanFindingsResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ImageNotFoundException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ScanNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the scan findings for the specified image.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" }, "smithy.waiters#waitable": { "ImageScanComplete": { "documentation": "Wait until an image scan is complete and findings can be accessed", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "imageScanStatus.status", "expected": "COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "imageScanStatus.status", "expected": "FAILED", "comparator": "stringEquals" } } } ], "minDelay": 5 } } } }, "com.amazonaws.ecr#DescribeImageScanFindingsRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository for the image for which to describe the scan findings.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribeImageScanFindings request where maxResults was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value\n is null when there are no more results to return.
The maximum number of image scan results returned by\n DescribeImageScanFindings in paginated output. When this parameter is\n used, DescribeImageScanFindings only returns maxResults\n results in a single page along with a nextToken response element. The\n remaining results of the initial request can be seen by sending another\n DescribeImageScanFindings request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImageScanFindings returns up to 100\n results and a nextToken value, if applicable.
The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier" }, "imageScanStatus": { "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { "smithy.api#documentation": "The current state of the scan.
" } }, "imageScanFindings": { "target": "com.amazonaws.ecr#ImageScanFindings", "traits": { "smithy.api#documentation": "The information contained in the image scan findings.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribeImageScanFindings request. When the results of a\n DescribeImageScanFindings request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null when there\n are no more results to return.
Returns the signing status for a specified image. If the image matched\n signing rules that reference different signing profiles, a status is returned\n for each profile.
\nFor more information, see Managed signing in the\n Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#DescribeImageSigningStatusRequest": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that contains the image.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#documentation": "An object containing identifying information for an image.
", "smithy.api#required": {} } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "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.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DescribeImageSigningStatusResponse": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#documentation": "An object with identifying information for the image.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry.
" } }, "signingStatuses": { "target": "com.amazonaws.ecr#ImageSigningStatusList", "traits": { "smithy.api#documentation": "A list of signing statuses for the specified image. Each status corresponds to a\n signing profile.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DescribeImages": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DescribeImagesRequest" }, "output": { "target": "com.amazonaws.ecr#DescribeImagesResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ImageNotFoundException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Returns metadata about the images in a repository.
\nStarting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.
The new version of Amazon ECR\n Basic Scanning doesn't use the ImageDetail$imageScanFindingsSummary and ImageDetail$imageScanStatus attributes from the API response to\n return scan results. Use the DescribeImageScanFindings API\n instead. For more information about Amazon Web Services native basic scanning, see Scan\n images for software vulnerabilities in Amazon ECR.
\nThe tag status with which to filter your DescribeImages results. You\n can filter results based on whether they are TAGGED or\n UNTAGGED.
The image status with which to filter your DescribeImages results.\n Valid values are ACTIVE, ARCHIVED, and ACTIVATING. \n If not specified, only images with ACTIVE status are returned.
An object representing a filter on a DescribeImages\n operation.
" } }, "com.amazonaws.ecr#DescribeImagesRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to describe images. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository that contains the images to describe.
", "smithy.api#required": {} } }, "imageIds": { "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { "smithy.api#documentation": "The list of image IDs for the requested repository.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribeImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify images with imageIds.
The maximum number of repository results returned by DescribeImages in\n paginated output. When this parameter is used, DescribeImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribeImages request with the returned nextToken\n value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribeImages returns up to\n 100 results and a nextToken value, if applicable. This\n option cannot be used when you specify images with imageIds.
The filter key and value with which to filter your DescribeImages\n results.
A list of ImageDetail objects that contain data about the\n image.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future DescribeImages\n request. When the results of a DescribeImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Returns the pull through cache rules for a registry.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "pullThroughCacheRules", "pageSize": "maxResults" } } }, "com.amazonaws.ecr#DescribePullThroughCacheRulesRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to return the pull through cache\n rules for. If you do not specify a registry, the default registry is assumed.
" } }, "ecrRepositoryPrefixes": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefixes associated with the pull through cache rules to return.\n If no repository prefix value is specified, all pull through cache rules are\n returned.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribePullThroughCacheRulesRequest request where\n maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more results to\n return.
The maximum number of pull through cache rules returned by\n DescribePullThroughCacheRulesRequest in paginated output. When this\n parameter is used, DescribePullThroughCacheRulesRequest only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribePullThroughCacheRulesRequest request with the returned\n nextToken value. This value can be between 1 and 1000. If this\n parameter is not used, then DescribePullThroughCacheRulesRequest returns up\n to 100 results and a nextToken value, if applicable.
The details of the pull through cache rules.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribePullThroughCacheRulesRequest request. When the results of a\n DescribePullThroughCacheRulesRequest request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to return.
Describes the settings for a registry. The replication configuration for a repository\n can be created or updated with the PutReplicationConfiguration API\n action.
" } }, "com.amazonaws.ecr#DescribeRegistryRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#DescribeRegistryResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "replicationConfiguration": { "target": "com.amazonaws.ecr#ReplicationConfiguration", "traits": { "smithy.api#documentation": "The replication configuration for the registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#DescribeReplicationBackfillResults": { "type": "operation", "input": { "target": "com.amazonaws.ecr#DescribeReplicationBackfillResultsRequest" }, "output": { "target": "com.amazonaws.ecr#DescribeReplicationBackfillResultsResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ReplicationBackfillNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns the status, progress, and per-image results for a replication backfill. The\n backfill to describe is identified by the replicationBackfillId returned by\n the StartReplicationBackfill operation.
The per-image results are available only after the replication backfill reaches a\n terminal status.
\nThe Amazon Web Services account ID associated with the registry that contains the replication\n backfill to describe. If you do not specify a registry, the default registry is assumed.
" } }, "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill to describe.
", "smithy.api#required": {} } }, "resultStatusFilter": { "target": "com.amazonaws.ecr#ReplicationBackfillResultStatus", "traits": { "smithy.api#documentation": "The status used to filter the returned results. Each result has a status of\n COMPLETE or FAILED. If you omit this parameter, results\n with both statuses are returned.
The maximum number of replication backfill results returned by\n DescribeReplicationBackfillResults in paginated output. When this\n parameter is used, DescribeReplicationBackfillResults only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another DescribeReplicationBackfillResults request with the returned\n nextToken value. This value can be between 1 and\n 1000. If this parameter is not used, then\n DescribeReplicationBackfillResults returns up to 100\n results and a nextToken value, if applicable.
The nextToken value returned from a previous paginated\n DescribeReplicationBackfillResults request where maxResults\n was used and the results exceeded the value of that parameter. Pagination continues from\n the end of the previous results that returned the nextToken value. This\n value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe registry ID associated with the request.
" } }, "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill.
" } }, "destination": { "target": "com.amazonaws.ecr#ReplicationDestination", "traits": { "smithy.api#documentation": "The destination Region and registry to which the images are replicated.
" } }, "status": { "target": "com.amazonaws.ecr#ReplicationBackfillStatus", "traits": { "smithy.api#documentation": "The current status of the replication backfill.
" } }, "failureCode": { "target": "com.amazonaws.ecr#ReplicationBackfillError", "traits": { "smithy.api#documentation": "The failure code for a replication backfill that has failed.
" } }, "progress": { "target": "com.amazonaws.ecr#ReplicationBackfillProgress", "traits": { "smithy.api#documentation": "The progress of the replication backfill, including the total, completed, and failed\n replication counts. This value is null until the replication backfill\n finishes preparing the set of images to replicate. It is therefore null\n while the replication backfill is PREPARING, and remains null\n if the replication backfill is stopped before preparation completes.
The per-image results for the replication backfill. Results are available only after\n the replication backfill reaches a terminal status.
" } }, "startedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the replication backfill was\n started.
" } }, "endedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the replication backfill ended.\n This value is null while the replication backfill is still in\n progress.
The nextToken value to include in a future\n DescribeReplicationBackfillResults request. When the results of a\n DescribeReplicationBackfillResults request exceed\n maxResults, this value can be used to retrieve the next page of results.\n This value is null when there are no more results to return.
Describes image repositories in a registry.
", "smithy.api#examples": [ { "title": "To describe all repositories in the current account", "documentation": "The following example obtains a list and description of all repositories in the default registry to which the current user has access.", "output": { "repositories": [ { "registryId": "012345678910", "repositoryName": "ubuntu", "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu" }, { "registryId": "012345678910", "repositoryName": "test", "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test" } ] } } ], "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "repositories", "pageSize": "maxResults" }, "smithy.test#smokeTests": [ { "id": "DescribeRepositoriesSuccess", "params": {}, "vendorParams": { "region": "us-west-2" }, "vendorParamsShape": "aws.test#AwsVendorParams", "expect": { "success": {} } } ] } }, "com.amazonaws.ecr#DescribeRepositoriesRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repositories to be\n described. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryNames": { "target": "com.amazonaws.ecr#RepositoryNameList", "traits": { "smithy.api#documentation": "A list of repositories to describe. If this parameter is omitted, then all\n repositories in a registry are described.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribeRepositories request where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is\n null when there are no more results to return. This option cannot be\n used when you specify repositories with repositoryNames.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of repository results returned by DescribeRepositories\n in paginated output. When this parameter is used, DescribeRepositories only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another DescribeRepositories request with\n the returned nextToken value. This value can be between 1\n and 1000. If this parameter is not used, then\n DescribeRepositories returns up to 100 results and a\n nextToken value, if applicable. This option cannot be used when you\n specify repositories with repositoryNames.
A list of repository objects corresponding to valid repositories.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribeRepositories request. When the results of a\n DescribeRepositories request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when\n there are no more results to return.
Returns details about the repository creation templates in a registry. The\n prefixes request parameter can be used to return the details for a\n specific repository creation template.
The repository namespace prefixes associated with the repository creation templates to\n describe. If this value is not specified, all repository creation templates are\n returned.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n DescribeRepositoryCreationTemplates request where\n maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more\n results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of repository results returned by\n DescribeRepositoryCreationTemplatesRequest in paginated output. When\n this parameter is used, DescribeRepositoryCreationTemplatesRequest only\n returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial\n request can be seen by sending another\n DescribeRepositoryCreationTemplatesRequest request with the returned\n nextToken value. This value can be between 1 and\n 1000. If this parameter is not used, then\n DescribeRepositoryCreationTemplatesRequest returns up to\n 100 results and a nextToken value, if applicable.
The registry ID associated with the request.
" } }, "repositoryCreationTemplates": { "target": "com.amazonaws.ecr#RepositoryCreationTemplateList", "traits": { "smithy.api#documentation": "The details of the repository creation templates.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n DescribeRepositoryCreationTemplates request. When the results of a\n DescribeRepositoryCreationTemplates request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified layer upload does not contain any layer parts.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#EncryptionConfiguration": { "type": "structure", "members": { "encryptionType": { "target": "com.amazonaws.ecr#EncryptionType", "traits": { "smithy.api#documentation": "The encryption type to use.
\nIf you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created.
If you use the KMS_DSSE encryption type, the contents of the repository\n will be encrypted with two layers of encryption using server-side encryption with the\n KMS Management Service key stored in KMS. Similar to the KMS encryption\n type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your\n own KMS key, which you've already created.
If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES256 encryption algorithm.
For more information, see Amazon ECR encryption at\n rest in the Amazon Elastic Container Registry User Guide.
", "smithy.api#required": {} } }, "kmsKey": { "target": "com.amazonaws.ecr#KmsKey", "traits": { "smithy.api#documentation": "If you use the KMS encryption type, specify the KMS key to use for\n encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key\n must exist in the same Region as the repository. If no key is specified, the default\n Amazon Web Services managed KMS key for Amazon ECR will be used.
The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.
\nBy default, when no encryption configuration is set or the AES256\n encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption\n keys which encrypts your data at rest using an AES256 encryption algorithm. This does\n not require any action on your part.
For more control over the encryption of the contents of your repository, you can use\n server-side encryption with Key Management Service key stored in Key Management Service (KMS) to encrypt your\n images. For more information, see Amazon ECR encryption at\n rest in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate": { "type": "structure", "members": { "encryptionType": { "target": "com.amazonaws.ecr#EncryptionType", "traits": { "smithy.api#documentation": "The encryption type to use.
\nIf you use the KMS encryption type, the contents of the repository will\n be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n for Amazon ECR, or specify your own KMS key, which you already created. For more\n information, see Protecting data using server-side\n encryption with an KMS key stored in Key Management Service (SSE-KMS) in the\n Amazon Simple Storage Service Console Developer Guide.
If you use the AES256 encryption type, Amazon ECR uses server-side encryption\n with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n AES256 encryption algorithm. For more information, see Protecting data using\n server-side encryption with Amazon S3-managed encryption keys (SSE-S3) in the\n Amazon Simple Storage Service Console Developer Guide.
If you use the KMS encryption type, specify the KMS key to use for\n encryption. The full ARN of the KMS key must be specified. The key must exist in the\n same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS\n key for Amazon ECR will be used.
The encryption configuration to associate with the repository creation\n template.
" } }, "com.amazonaws.ecr#EncryptionType": { "type": "enum", "members": { "AES256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AES256" } }, "KMS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS" } }, "KMS_DSSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KMS_DSSE" } } } }, "com.amazonaws.ecr#EnhancedImageScanFinding": { "type": "structure", "members": { "awsAccountId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the image.
" } }, "description": { "target": "com.amazonaws.ecr#FindingDescription", "traits": { "smithy.api#documentation": "The description of the finding.
" } }, "findingArn": { "target": "com.amazonaws.ecr#FindingArn", "traits": { "smithy.api#documentation": "The Amazon Resource Number (ARN) of the finding.
" } }, "firstObservedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time that the finding was first observed.
" } }, "lastObservedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time that the finding was last observed.
" } }, "packageVulnerabilityDetails": { "target": "com.amazonaws.ecr#PackageVulnerabilityDetails", "traits": { "smithy.api#documentation": "An object that contains the details of a package vulnerability finding.
" } }, "remediation": { "target": "com.amazonaws.ecr#Remediation", "traits": { "smithy.api#documentation": "An object that contains the details about how to remediate a finding.
" } }, "resources": { "target": "com.amazonaws.ecr#ResourceList", "traits": { "smithy.api#documentation": "Contains information on the resources involved in a finding.
" } }, "score": { "target": "com.amazonaws.ecr#Score", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The Amazon Inspector score given to the finding.
" } }, "scoreDetails": { "target": "com.amazonaws.ecr#ScoreDetails", "traits": { "smithy.api#documentation": "An object that contains details of the Amazon Inspector score.
" } }, "severity": { "target": "com.amazonaws.ecr#Severity", "traits": { "smithy.api#documentation": "The severity of the finding.
" } }, "status": { "target": "com.amazonaws.ecr#Status", "traits": { "smithy.api#documentation": "The status of the finding.
" } }, "title": { "target": "com.amazonaws.ecr#Title", "traits": { "smithy.api#documentation": "The title of the finding.
" } }, "type": { "target": "com.amazonaws.ecr#Type", "traits": { "smithy.api#documentation": "The type of the finding.
" } }, "updatedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time the finding was last updated at.
" } }, "fixAvailable": { "target": "com.amazonaws.ecr#FixAvailable", "traits": { "smithy.api#documentation": "Details on whether a fix is available through a version update. This value can be\n YES, NO, or PARTIAL. A PARTIAL\n fix means that some, but not all, of the packages identified in the finding have fixes\n available through updated versions.
If a finding discovered in your environment has an exploit available.
" } } }, "traits": { "smithy.api#documentation": "The details of an enhanced image scan. This is returned when enhanced scanning is\n enabled for your private registry.
" } }, "com.amazonaws.ecr#EnhancedImageScanFindingList": { "type": "list", "member": { "target": "com.amazonaws.ecr#EnhancedImageScanFinding" } }, "com.amazonaws.ecr#Epoch": { "type": "integer" }, "com.amazonaws.ecr#EvaluationTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#ExceptionMessage": { "type": "string" }, "com.amazonaws.ecr#ExclusionAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified pull time update exclusion already exists for the registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ExclusionNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified pull time update exclusion was not found.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ExpirationTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#ExploitAvailable": { "type": "string" }, "com.amazonaws.ecr#FiftyMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.ecr#FilePath": { "type": "string" }, "com.amazonaws.ecr#FindingArn": { "type": "string" }, "com.amazonaws.ecr#FindingDescription": { "type": "string" }, "com.amazonaws.ecr#FindingName": { "type": "string" }, "com.amazonaws.ecr#FindingSeverity": { "type": "enum", "members": { "INFORMATIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFORMATIONAL" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CRITICAL" } }, "UNDEFINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNDEFINED" } } } }, "com.amazonaws.ecr#FindingSeverityCounts": { "type": "map", "key": { "target": "com.amazonaws.ecr#FindingSeverity" }, "value": { "target": "com.amazonaws.ecr#SeverityCount" } }, "com.amazonaws.ecr#FixAvailable": { "type": "string" }, "com.amazonaws.ecr#FixedInVersion": { "type": "string" }, "com.amazonaws.ecr#ForceFlag": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.ecr#GetAccountSetting": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetAccountSettingRequest" }, "output": { "target": "com.amazonaws.ecr#GetAccountSettingResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the account setting value for the specified setting name.
" } }, "com.amazonaws.ecr#GetAccountSettingRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecr#AccountSettingName", "traits": { "smithy.api#documentation": "The name of the account setting, such as BASIC_SCAN_TYPE_VERSION,\n REGISTRY_POLICY_SCOPE, or BLOB_MOUNTING.
Retrieves the name of the account setting.
" } }, "value": { "target": "com.amazonaws.ecr#AccountSettingName", "traits": { "smithy.api#documentation": "The setting value for the setting name. Valid value for basic scan type: AWS_NATIVE.\n Valid values for registry policy scope: V2.\n Valid values for blob mounting: ENABLED or DISABLED.
Retrieves an authorization token. An authorization token represents your IAM\n authentication credentials and can be used to access any Amazon ECR registry that your IAM\n principal has access to. The authorization token is valid for 12 hours.
\nThe authorizationToken returned is a base64 encoded string that can be\n decoded and used in a docker login command to authenticate to a registry.\n The CLI offers an get-login-password command that simplifies the login\n process. For more information, see Registry\n authentication in the Amazon Elastic Container Registry User Guide.
A list of Amazon Web Services account IDs that are associated with the registries for which to get\n AuthorizationData objects. If you do not specify a registry, the default registry is assumed.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetAuthorizationTokenResponse": { "type": "structure", "members": { "authorizationData": { "target": "com.amazonaws.ecr#AuthorizationDataList", "traits": { "smithy.api#documentation": "A list of authorization token data objects that correspond to the\n registryIds values in the request.
The size of the authorization token returned by Amazon ECR is not fixed. We recommend\n that you don't make assumptions about the maximum size.
\nRetrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can\n only get URLs for image layers that are referenced in an image.
\nWhen an image is pulled, the GetDownloadUrlForLayer API is called once per image layer\n that is not already cached.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry that contains the image layer to\n download. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that is associated with the image layer to download.
", "smithy.api#required": {} } }, "layerDigest": { "target": "com.amazonaws.ecr#LayerDigest", "traits": { "smithy.api#documentation": "The digest of the image layer to download.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetDownloadUrlForLayerResponse": { "type": "structure", "members": { "downloadUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The pre-signed Amazon S3 download URL for the requested layer.
" } }, "layerDigest": { "target": "com.amazonaws.ecr#LayerDigest", "traits": { "smithy.api#documentation": "The digest of the image layer to download.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.ecr#GetLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the lifecycle policy for the specified repository.
" } }, "com.amazonaws.ecr#GetLifecyclePolicyPreview": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetLifecyclePolicyPreviewRequest" }, "output": { "target": "com.amazonaws.ecr#GetLifecyclePolicyPreviewResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the results of the lifecycle policy preview request for the specified\n repository.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "previewResults", "pageSize": "maxResults" }, "smithy.waiters#waitable": { "LifecyclePolicyPreviewComplete": { "documentation": "Wait until a lifecycle policy preview request is complete and results can be accessed", "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "COMPLETE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } } ], "minDelay": 5 } } } }, "com.amazonaws.ecr#GetLifecyclePolicyPreviewRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
", "smithy.api#required": {} } }, "imageIds": { "target": "com.amazonaws.ecr#ImageIdentifierList", "traits": { "smithy.api#documentation": "The list of imageIDs to be included.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\u2028\n GetLifecyclePolicyPreviewRequest request where maxResults\n was used and the\u2028 results exceeded the value of that parameter. Pagination continues\n from the end of the\u2028 previous results that returned the nextToken value.\n This value is\u2028 null when there are no more results to return. This option\n cannot be used when you specify images with imageIds.
The maximum number of repository results returned by\n GetLifecyclePolicyPreviewRequest in\u2028 paginated output. When this\n parameter is used, GetLifecyclePolicyPreviewRequest only returns\u2028\n maxResults results in a single page along with a\n nextToken\u2028 response element. The remaining results of the initial request\n can be seen by sending\u2028 another GetLifecyclePolicyPreviewRequest request\n with the returned nextToken\u2028 value. This value can be between\n 1 and 100. If this\u2028 parameter is not used, then\n GetLifecyclePolicyPreviewRequest returns up to\u2028100\n results and a nextToken value, if\u2028 applicable. This option cannot be used\n when you specify images with imageIds.
An optional parameter that filters results based on image tag status and all tags, if\n tagged.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetLifecyclePolicyPreviewResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON lifecycle policy text.
" } }, "status": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", "traits": { "smithy.api#documentation": "The status of the lifecycle policy preview request.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n GetLifecyclePolicyPreview request. When the results of a\n GetLifecyclePolicyPreview request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null\n when there are no more results to return.
The results of the lifecycle policy preview request.
" } }, "summary": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewSummary", "traits": { "smithy.api#documentation": "The list of images that is returned as a result of the action.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetLifecyclePolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetLifecyclePolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON lifecycle policy text.
" } }, "lastEvaluatedAt": { "target": "com.amazonaws.ecr#EvaluationTimestamp", "traits": { "smithy.api#documentation": "The time stamp of the last time that the lifecycle policy was run.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetRegistryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetRegistryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#GetRegistryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RegistryPolicyNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the permissions policy for a registry.
" } }, "com.amazonaws.ecr#GetRegistryPolicyRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetRegistryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RegistryPolicyText", "traits": { "smithy.api#documentation": "The JSON text of the permissions policy for a registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetRegistryScanningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the scanning configuration for a registry.
" } }, "com.amazonaws.ecr#GetRegistryScanningConfigurationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetRegistryScanningConfigurationResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "scanningConfiguration": { "target": "com.amazonaws.ecr#RegistryScanningConfiguration", "traits": { "smithy.api#documentation": "The scanning configuration for the registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetRepositoryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetRepositoryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#GetRepositoryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryPolicyNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Retrieves the repository policy for the specified repository.
", "smithy.api#examples": [ { "title": "To get the current policy for a repository", "documentation": "This example obtains the repository policy for the repository named ubuntu.", "input": { "repositoryName": "ubuntu" }, "output": { "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}", "repositoryName": "ubuntu", "registryId": "012345678901" } } ] } }, "com.amazonaws.ecr#GetRepositoryPolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository with the policy to retrieve.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetRepositoryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text associated with the repository.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#GetSigningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#GetSigningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#GetSigningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#SigningConfigurationNotFoundException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the registry's signing configuration, which defines\n rules for automatically signing images using Amazon Web Services Signer.
\nFor more information, see Managed signing in the\n Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#GetSigningConfigurationRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#GetSigningConfigurationResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry.
" } }, "signingConfiguration": { "target": "com.amazonaws.ecr#SigningConfiguration", "traits": { "smithy.api#documentation": "The registry's signing configuration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#Image": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry containing the image.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository associated with the image.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#documentation": "An object containing the image tag and image digest associated with an image.
" } }, "imageManifest": { "target": "com.amazonaws.ecr#ImageManifest", "traits": { "smithy.api#documentation": "The image manifest associated with the image.
" } }, "imageManifestMediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The manifest media type of the image.
" } } }, "traits": { "smithy.api#documentation": "An object representing an Amazon ECR image.
" } }, "com.amazonaws.ecr#ImageActionType": { "type": "enum", "members": { "EXPIRE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRE" } }, "TRANSITION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSITION" } } } }, "com.amazonaws.ecr#ImageAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified image has already been pushed, and there were no changes to the manifest\n or image tag after the last push.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageArchivedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified image is archived and cannot be scanned.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.ecr#ImageDetail": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to which this image belongs.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to which this image belongs.
" } }, "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The sha256 digest of the image manifest.
The list of tags associated with this image.
" } }, "imageSizeInBytes": { "target": "com.amazonaws.ecr#ImageSizeInBytes", "traits": { "smithy.api#documentation": "The size, in bytes, of the image in the repository.
\nIf the image is a manifest list, this will be the max size of all manifests in the\n list.
\nStarting with Docker version 1.9, the Docker client compresses image layers before\n pushing them to a V2 Docker registry. The output of the docker images\n command shows the uncompressed image size. Therefore, Docker might return a larger\n image than the image shown in the Amazon Web Services Management Console.
The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.
" } }, "imageScanStatus": { "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { "smithy.api#documentation": "The current state of the scan.
" } }, "imageScanFindingsSummary": { "target": "com.amazonaws.ecr#ImageScanFindingsSummary", "traits": { "smithy.api#documentation": "A summary of the last completed image scan.
" } }, "imageManifestMediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The media type of the image manifest.
" } }, "artifactMediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The artifact media type of the image.
" } }, "lastRecordedPullTime": { "target": "com.amazonaws.ecr#RecordedPullTimestamp", "traits": { "smithy.api#documentation": "The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded\n the last image pull.
\nAmazon ECR refreshes the last image pull timestamp at least once every 24 hours. For\n example, if you pull an image once a day then the lastRecordedPullTime\n timestamp will indicate the exact time that the image was last pulled. However, if\n you pull an image once an hour, because Amazon ECR refreshes the\n lastRecordedPullTime timestamp at least once every 24 hours, the\n result may not be the exact time that the image was last pulled.
The digest of the subject manifest for images that are referrers.
" } }, "imageStatus": { "target": "com.amazonaws.ecr#ImageStatus", "traits": { "smithy.api#documentation": "The current status of the image.
" } }, "lastArchivedAt": { "target": "com.amazonaws.ecr#LastArchivedAtTimestamp", "traits": { "smithy.api#documentation": "The date and time, expressed in standard JavaScript date format, when the image was last transitioned to Amazon ECR archive.
" } }, "lastActivatedAt": { "target": "com.amazonaws.ecr#LastActivatedAtTimestamp", "traits": { "smithy.api#documentation": "The date and time, expressed in standard JavaScript date format, when the image was last restored from Amazon ECR archive to Amazon ECR standard.
" } } }, "traits": { "smithy.api#documentation": "An object that describes an image returned by a DescribeImages\n operation.
" } }, "com.amazonaws.ecr#ImageDetailList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageDetail" } }, "com.amazonaws.ecr#ImageDigest": { "type": "string" }, "com.amazonaws.ecr#ImageDigestDoesNotMatchException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified image digest does not match the digest that Amazon ECR calculated for the\n image.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageFailure": { "type": "structure", "members": { "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#documentation": "The image ID associated with the failure.
" } }, "failureCode": { "target": "com.amazonaws.ecr#ImageFailureCode", "traits": { "smithy.api#documentation": "The code associated with the failure.
" } }, "failureReason": { "target": "com.amazonaws.ecr#ImageFailureReason", "traits": { "smithy.api#documentation": "The reason for the failure.
" } } }, "traits": { "smithy.api#documentation": "An object representing an Amazon ECR image failure.
" } }, "com.amazonaws.ecr#ImageFailureCode": { "type": "enum", "members": { "InvalidImageDigest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidImageDigest" } }, "InvalidImageTag": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidImageTag" } }, "ImageTagDoesNotMatchDigest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ImageTagDoesNotMatchDigest" } }, "ImageNotFound": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ImageNotFound" } }, "MissingDigestAndTag": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MissingDigestAndTag" } }, "ImageReferencedByManifestList": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ImageReferencedByManifestList" } }, "KmsError": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KmsError" } }, "UpstreamAccessDenied": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpstreamAccessDenied" } }, "UpstreamTooManyRequests": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpstreamTooManyRequests" } }, "UpstreamUnavailable": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UpstreamUnavailable" } }, "ImageInaccessible": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ImageInaccessible" } } } }, "com.amazonaws.ecr#ImageFailureList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageFailure" } }, "com.amazonaws.ecr#ImageFailureReason": { "type": "string" }, "com.amazonaws.ecr#ImageIdentifier": { "type": "structure", "members": { "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The sha256 digest of the image manifest.
The tag used for the image.
" } } }, "traits": { "smithy.api#documentation": "An object with identifying information for an image in an Amazon ECR repository.
" } }, "com.amazonaws.ecr#ImageIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageIdentifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#ImageList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Image" } }, "com.amazonaws.ecr#ImageManifest": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4194304 } } }, "com.amazonaws.ecr#ImageNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The image requested does not exist in the specified repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageReferrer": { "type": "structure", "members": { "digest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The digest of the artifact manifest.
", "smithy.api#required": {} } }, "mediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The media type of the artifact manifest.
", "smithy.api#required": {} } }, "artifactType": { "target": "com.amazonaws.ecr#ArtifactType", "traits": { "smithy.api#documentation": "A string identifying the type of artifact.
" } }, "size": { "target": "com.amazonaws.ecr#ImageSizeInBytes", "traits": { "smithy.api#documentation": "The size, in bytes, of the artifact.
", "smithy.api#required": {} } }, "annotations": { "target": "com.amazonaws.ecr#Annotations", "traits": { "smithy.api#documentation": "A map of annotations associated with the artifact.
" } }, "artifactStatus": { "target": "com.amazonaws.ecr#ArtifactStatus", "traits": { "smithy.api#documentation": "The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.
An object representing an artifact associated with a subject image.
" } }, "com.amazonaws.ecr#ImageReferrerList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageReferrer" } }, "com.amazonaws.ecr#ImageReplicationStatus": { "type": "structure", "members": { "region": { "target": "com.amazonaws.ecr#Region", "traits": { "smithy.api#documentation": "The destination Region for the image replication.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry to which the image belongs.
" } }, "status": { "target": "com.amazonaws.ecr#ReplicationStatus", "traits": { "smithy.api#documentation": "The image replication status.
" } }, "failureCode": { "target": "com.amazonaws.ecr#ReplicationError", "traits": { "smithy.api#documentation": "The failure code for a replication that has failed.
" } } }, "traits": { "smithy.api#documentation": "The status of the replication process for an image.
" } }, "com.amazonaws.ecr#ImageReplicationStatusList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageReplicationStatus" } }, "com.amazonaws.ecr#ImageScanFinding": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecr#FindingName", "traits": { "smithy.api#documentation": "The name associated with the finding, usually a CVE number.
" } }, "description": { "target": "com.amazonaws.ecr#FindingDescription", "traits": { "smithy.api#documentation": "The description of the finding.
" } }, "uri": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "A link containing additional details about the security vulnerability.
" } }, "severity": { "target": "com.amazonaws.ecr#FindingSeverity", "traits": { "smithy.api#documentation": "The finding severity.
" } }, "attributes": { "target": "com.amazonaws.ecr#AttributeList", "traits": { "smithy.api#documentation": "A collection of attributes of the host from which the finding is generated.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an image scan finding.
" } }, "com.amazonaws.ecr#ImageScanFindingList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageScanFinding" } }, "com.amazonaws.ecr#ImageScanFindings": { "type": "structure", "members": { "imageScanCompletedAt": { "target": "com.amazonaws.ecr#ScanTimestamp", "traits": { "smithy.api#documentation": "The time of the last completed image scan.
" } }, "vulnerabilitySourceUpdatedAt": { "target": "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp", "traits": { "smithy.api#documentation": "The time when the vulnerability data was last scanned.
" } }, "findingSeverityCounts": { "target": "com.amazonaws.ecr#FindingSeverityCounts", "traits": { "smithy.api#documentation": "The image vulnerability counts, sorted by severity.
" } }, "findings": { "target": "com.amazonaws.ecr#ImageScanFindingList", "traits": { "smithy.api#documentation": "The findings from the image scan.
" } }, "enhancedFindings": { "target": "com.amazonaws.ecr#EnhancedImageScanFindingList", "traits": { "smithy.api#documentation": "Details about the enhanced scan findings from Amazon Inspector.
" } } }, "traits": { "smithy.api#documentation": "The details of an image scan.
" } }, "com.amazonaws.ecr#ImageScanFindingsSummary": { "type": "structure", "members": { "imageScanCompletedAt": { "target": "com.amazonaws.ecr#ScanTimestamp", "traits": { "smithy.api#documentation": "The time of the last completed image scan.
" } }, "vulnerabilitySourceUpdatedAt": { "target": "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp", "traits": { "smithy.api#documentation": "The time when the vulnerability data was last scanned.
" } }, "findingSeverityCounts": { "target": "com.amazonaws.ecr#FindingSeverityCounts", "traits": { "smithy.api#documentation": "The image vulnerability counts, sorted by severity.
" } } }, "traits": { "smithy.api#documentation": "A summary of the last completed image scan.
" } }, "com.amazonaws.ecr#ImageScanStatus": { "type": "structure", "members": { "status": { "target": "com.amazonaws.ecr#ScanStatus", "traits": { "smithy.api#documentation": "The current state of an image scan.
" } }, "description": { "target": "com.amazonaws.ecr#ScanStatusDescription", "traits": { "smithy.api#documentation": "The description of the image scan status.
" } } }, "traits": { "smithy.api#documentation": "The current status of an image scan.
" } }, "com.amazonaws.ecr#ImageScanningConfiguration": { "type": "structure", "members": { "scanOnPush": { "target": "com.amazonaws.ecr#ScanOnPushFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "The setting that determines whether images are scanned after being pushed to a\n repository. If set to true, images will be scanned after being pushed. If\n this parameter is not specified, it will default to false and images will\n not be scanned unless a scan is manually started with the API_StartImageScan API.
The image scanning configuration for a repository.
" } }, "com.amazonaws.ecr#ImageSigningStatus": { "type": "structure", "members": { "signingProfileArn": { "target": "com.amazonaws.ecr#SigningProfileArn", "traits": { "smithy.api#documentation": "The ARN of the Amazon Web Services Signer signing profile used to sign the image.
" } }, "failureCode": { "target": "com.amazonaws.ecr#SigningStatusFailureCode", "traits": { "smithy.api#documentation": "The failure code, which is only present if status\n is FAILED.
A description of why signing the image failed. This field is only\n present if status is FAILED.
The image's signing status. Possible values are:
\n\n IN_PROGRESS - Signing is currently in progress.
\n COMPLETE - The signature was successfully generated.
\n FAILED - Signing failed. See\n failureCode and failureReason for details.
The signing status for an image. Each status corresponds to a signing profile.
" } }, "com.amazonaws.ecr#ImageSigningStatusList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageSigningStatus" } }, "com.amazonaws.ecr#ImageSizeInBytes": { "type": "long" }, "com.amazonaws.ecr#ImageStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "ACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING" } } } }, "com.amazonaws.ecr#ImageStatusFilter": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } }, "ACTIVATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVATING" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.ecr#ImageStorageClassUpdateNotSupportedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The requested image storage class update is not supported.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageTag": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 300 } } }, "com.amazonaws.ecr#ImageTagAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified image is tagged with a tag that already exists. The repository is\n configured for tag immutability.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ImageTagList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageTag" } }, "com.amazonaws.ecr#ImageTagMutability": { "type": "enum", "members": { "MUTABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUTABLE" } }, "IMMUTABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMMUTABLE" } }, "IMMUTABLE_WITH_EXCLUSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMMUTABLE_WITH_EXCLUSION" } }, "MUTABLE_WITH_EXCLUSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MUTABLE_WITH_EXCLUSION" } } } }, "com.amazonaws.ecr#ImageTagMutabilityExclusionFilter": { "type": "structure", "members": { "filterType": { "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterType", "traits": { "smithy.api#documentation": "The type of filter to apply for excluding image tags from mutability settings.
", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterValue", "traits": { "smithy.api#documentation": "The filter value used to match image tags for exclusion from mutability\n settings.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A filter that specifies which image tags should be excluded from the repository's\n image tag mutability setting.
" } }, "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterType": { "type": "enum", "members": { "WILDCARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WILDCARD" } } } }, "com.amazonaws.ecr#ImageTagMutabilityExclusionFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[0-9a-zA-Z._*-]{1,128}$" } }, "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.ecr#ImageTagsList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ImageTag" } }, "com.amazonaws.ecr#InUseCount": { "type": "long", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.ecr#InitiateLayerUpload": { "type": "operation", "input": { "target": "com.amazonaws.ecr#InitiateLayerUploadRequest" }, "output": { "target": "com.amazonaws.ecr#InitiateLayerUploadResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Notifies Amazon ECR that you intend to upload an image layer.
\nWhen an image is pushed, the InitiateLayerUpload API is called once per image layer\n that has not already been uploaded. Whether or not an image layer has been uploaded is\n determined by the BatchCheckLayerAvailability API action.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry to which you intend to upload\n layers. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to which you intend to upload layers.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#InitiateLayerUploadResponse": { "type": "structure", "members": { "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload\n operations.
" } }, "partSize": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "The size, in bytes, that Amazon ECR expects future layer part uploads to be.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#InvalidLayerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The layer digest calculation performed by Amazon ECR upon receipt of the image layer does\n not match the digest specified.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#InvalidLayerPartException": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the exception.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the exception.
" } }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID associated with the exception.
" } }, "lastValidByteReceived": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "The last valid byte received from the layer part upload that is associated with the\n exception.
" } }, "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The layer part size is not valid, or the first byte specified is not consecutive to\n the last byte of a previous layer part upload.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#InvalidParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#InvalidTagParameterException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#IsPTCRuleValid": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.ecr#KmsError": { "type": "string" }, "com.amazonaws.ecr#KmsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" }, "kmsError": { "target": "com.amazonaws.ecr#KmsError", "traits": { "smithy.api#documentation": "The error code returned by KMS.
" } } }, "traits": { "smithy.api#documentation": "The operation failed due to a KMS exception.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#KmsKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.ecr#KmsKeyForRepositoryCreationTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^$|arn:aws[a-z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key\\/[a-z0-9-]+$" } }, "com.amazonaws.ecr#LastActivatedAtTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#LastArchivedAtTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#Layer": { "type": "structure", "members": { "layerDigest": { "target": "com.amazonaws.ecr#LayerDigest", "traits": { "smithy.api#documentation": "The sha256 digest of the image layer.
The availability status of the image layer.
" } }, "layerSize": { "target": "com.amazonaws.ecr#LayerSizeInBytes", "traits": { "smithy.api#documentation": "The size, in bytes, of the image layer.
" } }, "mediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The media type of the layer, such as\n application/vnd.docker.image.rootfs.diff.tar.gzip or\n application/vnd.oci.image.layer.v1.tar+gzip.
An object representing an Amazon ECR image layer.
" } }, "com.amazonaws.ecr#LayerAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The image layer already exists in the associated repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LayerAvailability": { "type": "enum", "members": { "AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABLE" } }, "UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNAVAILABLE" } }, "ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVED" } } } }, "com.amazonaws.ecr#LayerDigest": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+$" } }, "com.amazonaws.ecr#LayerDigestList": { "type": "list", "member": { "target": "com.amazonaws.ecr#LayerDigest" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#LayerFailure": { "type": "structure", "members": { "layerDigest": { "target": "com.amazonaws.ecr#BatchedOperationLayerDigest", "traits": { "smithy.api#documentation": "The layer digest associated with the failure.
" } }, "failureCode": { "target": "com.amazonaws.ecr#LayerFailureCode", "traits": { "smithy.api#documentation": "The failure code associated with the failure.
" } }, "failureReason": { "target": "com.amazonaws.ecr#LayerFailureReason", "traits": { "smithy.api#documentation": "The reason for the failure.
" } } }, "traits": { "smithy.api#documentation": "An object representing an Amazon ECR image layer failure.
" } }, "com.amazonaws.ecr#LayerFailureCode": { "type": "enum", "members": { "InvalidLayerDigest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidLayerDigest" } }, "MissingLayerDigest": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MissingLayerDigest" } } } }, "com.amazonaws.ecr#LayerFailureList": { "type": "list", "member": { "target": "com.amazonaws.ecr#LayerFailure" } }, "com.amazonaws.ecr#LayerFailureReason": { "type": "string" }, "com.amazonaws.ecr#LayerInaccessibleException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified layer is not available because it is not associated with an image.\n Unassociated image layers may be cleaned up at any time.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LayerList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Layer" } }, "com.amazonaws.ecr#LayerPartBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 0, "max": 20971520 } } }, "com.amazonaws.ecr#LayerPartTooSmallException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "Layer parts must be at least 5 MiB in size.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LayerSizeInBytes": { "type": "long" }, "com.amazonaws.ecr#LayersNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified layers could not be found, or the specified layer is not valid for this\n repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LifecyclePolicyNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The lifecycle policy could not be found, and no policy is set to the\n repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewFilter": { "type": "structure", "members": { "tagStatus": { "target": "com.amazonaws.ecr#TagStatus", "traits": { "smithy.api#documentation": "The tag status of the image.
" } } }, "traits": { "smithy.api#documentation": "The filter for the lifecycle policy preview.
" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewInProgressException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The previous lifecycle policy preview request has not completed. Wait and try\n again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "There is no dry run for this repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewResult": { "type": "structure", "members": { "imageTags": { "target": "com.amazonaws.ecr#ImageTagList", "traits": { "smithy.api#documentation": "The list of tags associated with this image.
" } }, "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The sha256 digest of the image manifest.
The date and time, expressed in standard JavaScript date format, at which the current\n image was pushed to the repository.
" } }, "action": { "target": "com.amazonaws.ecr#LifecyclePolicyRuleAction", "traits": { "smithy.api#documentation": "The type of action to be taken.
" } }, "appliedRulePriority": { "target": "com.amazonaws.ecr#LifecyclePolicyRulePriority", "traits": { "smithy.api#documentation": "The priority of the applied rule.
" } }, "storageClass": { "target": "com.amazonaws.ecr#LifecyclePolicyStorageClass", "traits": { "smithy.api#documentation": "The storage class of the image.
" } } }, "traits": { "smithy.api#documentation": "The result of the lifecycle policy preview.
" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewResultList": { "type": "list", "member": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewResult" } }, "com.amazonaws.ecr#LifecyclePolicyPreviewStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.ecr#LifecyclePolicyPreviewSummary": { "type": "structure", "members": { "expiringImageTotalCount": { "target": "com.amazonaws.ecr#ImageCount", "traits": { "smithy.api#documentation": "The number of expiring images.
" } }, "transitioningImageTotalCounts": { "target": "com.amazonaws.ecr#TransitioningImageTotalCounts", "traits": { "smithy.api#documentation": "The total count of images that will be transitioned to each storage class.\n This field is only present if at least one image will be transitoned in the summary.
" } } }, "traits": { "smithy.api#documentation": "The summary of the lifecycle policy preview request.
" } }, "com.amazonaws.ecr#LifecyclePolicyRuleAction": { "type": "structure", "members": { "type": { "target": "com.amazonaws.ecr#ImageActionType", "traits": { "smithy.api#documentation": "The type of action to be taken.
" } }, "targetStorageClass": { "target": "com.amazonaws.ecr#LifecyclePolicyTargetStorageClass", "traits": { "smithy.api#documentation": "The target storage class for the action. This is only present when the type is TRANSITION.\n
The type of action to be taken.
" } }, "com.amazonaws.ecr#LifecyclePolicyRulePriority": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.ecr#LifecyclePolicyStorageClass": { "type": "enum", "members": { "ARCHIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVE" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.ecr#LifecyclePolicyTargetStorageClass": { "type": "enum", "members": { "ARCHIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVE" } } } }, "com.amazonaws.ecr#LifecyclePolicyText": { "type": "string", "traits": { "smithy.api#length": { "min": 100, "max": 30720 } } }, "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 30720 } } }, "com.amazonaws.ecr#LifecyclePreviewMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The operation did not succeed because it would have exceeded a service limit for your\n account. For more information, see Amazon ECR service quotas in\n the Amazon Elastic Container Registry User Guide.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ListImageReferrers": { "type": "operation", "input": { "target": "com.amazonaws.ecr#ListImageReferrersRequest" }, "output": { "target": "com.amazonaws.ecr#ListImageReferrersResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#UnableToListUpstreamImageReferrersException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the artifacts associated with a specified subject image.
\nThe IAM principal invoking this operation must have the ecr:BatchGetImage permission.
The artifact types with which to filter your ListImageReferrers results.
" } }, "artifactStatus": { "target": "com.amazonaws.ecr#ArtifactStatusFilter", "traits": { "smithy.api#documentation": "The artifact status with which to filter your ListImageReferrers results. Valid values are ACTIVE, ARCHIVED, ACTIVATING, or ANY. If not specified, only artifacts with ACTIVE status are returned.
An object representing a filter on a ListImageReferrers operation.
" } }, "com.amazonaws.ecr#ListImageReferrersRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to list image referrers. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that contains the subject image.
", "smithy.api#required": {} } }, "subjectId": { "target": "com.amazonaws.ecr#SubjectIdentifier", "traits": { "smithy.api#documentation": "An object containing the image digest of the subject image for which to retrieve associated artifacts.
", "smithy.api#required": {} } }, "filter": { "target": "com.amazonaws.ecr#ListImageReferrersFilter", "traits": { "smithy.api#documentation": "The filter key and value with which to filter your ListImageReferrers\n results. If no filter is specified, only artifacts with ACTIVE status are returned.
The nextToken value returned from a previous paginated\n ListImageReferrers request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of image referrer results returned by ListImageReferrers in paginated\n output. When this parameter is used, ListImageReferrers only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListImageReferrers request with the returned nextToken value.\n This value can be between 1 and 50. If this parameter is\n not used, then ListImageReferrers returns up to 20 results and a\n nextToken value, if applicable.
The list of artifacts associated with the subject image.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListImageReferrers\n request. When the results of a ListImageReferrers request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Lists all the image IDs for the specified repository.
\nYou can filter images based on whether or not they are tagged by using the\n tagStatus filter and specifying either TAGGED,\n UNTAGGED or ANY. For example, you can filter your results\n to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your\n results to return only TAGGED images to list all of the tags in your\n repository.
The tag status with which to filter your ListImages results.
" } }, "imageStatus": { "target": "com.amazonaws.ecr#ImageStatusFilter", "traits": { "smithy.api#documentation": "The image status with which to filter your ListImages results.\n Valid values are ACTIVE, ARCHIVED, and ACTIVATING.\n If not specified, only images with ACTIVE status are returned.
An object representing a filter on a ListImages operation.
" } }, "com.amazonaws.ecr#ListImagesRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to list images. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository with image IDs to be listed.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value returned from a previous paginated\n ListImages request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of image results returned by ListImages in paginated\n output. When this parameter is used, ListImages only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListImages request with the returned nextToken value.\n This value can be between 1 and 1000. If this parameter is\n not used, then ListImages returns up to 100 results and a\n nextToken value, if applicable.
The filter key and value with which to filter your ListImages\n results.
The list of image IDs for the requested repository.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListImages\n request. When the results of a ListImages request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Lists the IAM principals that are excluded from having their image pull times recorded.
", "smithy.api#examples": [ { "title": "To list all pull time update exclusions", "documentation": "This example lists all IAM principals that are excluded from having their image pull timestamps recorded in the registry.", "output": { "pullTimeUpdateExclusions": [ "arn:aws:iam::012345678910:role/ECRAccess" ] } }, { "title": "To list pull time update exclusions with pagination", "documentation": "This example lists pull time update exclusions with pagination, requesting a maximum of 2 results per page.", "input": { "maxResults": 2 }, "output": { "pullTimeUpdateExclusions": [ "arn:aws:iam::012345678910:role/ECRAccess", "arn:aws:iam::012345678910:role/CICDPipeline" ], "nextToken": "eyJlbmNyeXB0ZWREYXRhIjpbXX0=" } } ] } }, "com.amazonaws.ecr#ListPullTimeUpdateExclusionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.ecr#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of pull time update exclusion results returned by ListPullTimeUpdateExclusions in\n paginated output. When this parameter is used, ListPullTimeUpdateExclusions only returns\n maxResults results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListPullTimeUpdateExclusions request with the returned nextToken value.\n This value can be between 1 and 1000. If this parameter is\n not used, then ListPullTimeUpdateExclusions returns up to 100 results and a\n nextToken value, if applicable.
The nextToken value returned from a previous paginated\n ListPullTimeUpdateExclusions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of IAM principal ARNs that are excluded from having their image pull times recorded.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future ListPullTimeUpdateExclusions\n request. When the results of a ListPullTimeUpdateExclusions request exceed\n maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Lists the replication backfills for a registry, including their status and\n progress.
\nReplication backfills that have reached a terminal status are retained for 90 days\n after they end, after which they are no longer returned.
\nThe Amazon Web Services account ID associated with the registry for which to list replication\n backfills. If you do not specify a registry, the default registry is assumed.
" } }, "maxResults": { "target": "com.amazonaws.ecr#FiftyMaxResults", "traits": { "smithy.api#documentation": "The maximum number of replication backfill results returned by\n ListReplicationBackfills in paginated output. When this parameter is\n used, ListReplicationBackfills only returns maxResults results\n in a single page along with a nextToken response element. The remaining\n results of the initial request can be seen by sending another\n ListReplicationBackfills request with the returned\n nextToken value. This value can be between 1 and 50. If this parameter\n is not used, then ListReplicationBackfills returns up to 25 results and a\n nextToken value, if applicable.
The nextToken value returned from a previous paginated\n ListReplicationBackfills request where maxResults was used\n and the results exceeded the value of that parameter. Pagination continues from the end\n of the previous results that returned the nextToken value. This value is\n null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe registry ID associated with the request.
" } }, "backfills": { "target": "com.amazonaws.ecr#ReplicationBackfillSummaryList", "traits": { "smithy.api#documentation": "A list of the replication backfills for the registry.
" } }, "nextToken": { "target": "com.amazonaws.ecr#NextToken", "traits": { "smithy.api#documentation": "The nextToken value to include in a future\n ListReplicationBackfills request. When the results of a\n ListReplicationBackfills request exceed maxResults, this\n value can be used to retrieve the next page of results. This value is null\n when there are no more results to return.
List the tags for an Amazon ECR resource.
" } }, "com.amazonaws.ecr#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ecr#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n only supported resource is an Amazon ECR repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The tags for the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.ecr#MediaType": { "type": "string" }, "com.amazonaws.ecr#MediaTypeList": { "type": "list", "member": { "target": "com.amazonaws.ecr#MediaType" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#Metric": { "type": "string" }, "com.amazonaws.ecr#NextToken": { "type": "string" }, "com.amazonaws.ecr#NonNegativeInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.ecr#PTCValidateFailure": { "type": "string" }, "com.amazonaws.ecr#PackageManager": { "type": "string" }, "com.amazonaws.ecr#PackageVulnerabilityDetails": { "type": "structure", "members": { "cvss": { "target": "com.amazonaws.ecr#CvssScoreList", "traits": { "smithy.api#documentation": "An object that contains details about the CVSS score of a finding.
" } }, "referenceUrls": { "target": "com.amazonaws.ecr#ReferenceUrlsList", "traits": { "smithy.api#documentation": "One or more URLs that contain details about this vulnerability type.
" } }, "relatedVulnerabilities": { "target": "com.amazonaws.ecr#RelatedVulnerabilitiesList", "traits": { "smithy.api#documentation": "One or more vulnerabilities related to the one identified in this finding.
" } }, "source": { "target": "com.amazonaws.ecr#Source", "traits": { "smithy.api#documentation": "The source of the vulnerability information.
" } }, "sourceUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "A URL to the source of the vulnerability information.
" } }, "vendorCreatedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time that this vulnerability was first added to the vendor's\n database.
" } }, "vendorSeverity": { "target": "com.amazonaws.ecr#Severity", "traits": { "smithy.api#documentation": "The severity the vendor has given to this vulnerability type.
" } }, "vendorUpdatedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time the vendor last updated this vulnerability in their database.
" } }, "vulnerabilityId": { "target": "com.amazonaws.ecr#VulnerabilityId", "traits": { "smithy.api#documentation": "The ID given to this vulnerability.
" } }, "vulnerablePackages": { "target": "com.amazonaws.ecr#VulnerablePackagesList", "traits": { "smithy.api#documentation": "The packages impacted by this vulnerability.
" } } }, "traits": { "smithy.api#documentation": "Information about a package vulnerability finding.
" } }, "com.amazonaws.ecr#PartSize": { "type": "long", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.ecr#Platform": { "type": "string" }, "com.amazonaws.ecr#Prefix": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^([a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*(\\/[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*)*\\/?|ROOT)$" } }, "com.amazonaws.ecr#PrefixList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Prefix" } }, "com.amazonaws.ecr#PrincipalArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^arn:aws(-[a-z]+)*:iam::[0-9]{12}:(role|user)/[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" } }, "com.amazonaws.ecr#ProxyEndpoint": { "type": "string" }, "com.amazonaws.ecr#PullThroughCacheRule": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule.
" } }, "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" } }, "createdAt": { "target": "com.amazonaws.ecr#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time the pull through cache was created.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry the pull through cache rule is\n associated with.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The ARN of the Secrets Manager secret associated with the pull through cache rule.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the pull through cache rule.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The upstream repository prefix associated with the pull through cache rule.
" } }, "upstreamRegistry": { "target": "com.amazonaws.ecr#UpstreamRegistry", "traits": { "smithy.api#documentation": "The name of the upstream source registry associated with the pull through cache\n rule.
" } }, "updatedAt": { "target": "com.amazonaws.ecr#UpdatedTimestamp", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the pull through cache rule was\n last updated.
" } } }, "traits": { "smithy.api#documentation": "The details of a pull through cache rule.
" } }, "com.amazonaws.ecr#PullThroughCacheRuleAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "A pull through cache rule with these settings already exists for the private\n registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#PullThroughCacheRuleList": { "type": "list", "member": { "target": "com.amazonaws.ecr#PullThroughCacheRule" } }, "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The pull through cache rule was not found. Specify a valid pull through cache rule and\n try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 30 }, "smithy.api#pattern": "^([a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*(\\/[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*)*\\/?|ROOT)$" } }, "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefixList": { "type": "list", "member": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#PullTimeUpdateExclusionList": { "type": "list", "member": { "target": "com.amazonaws.ecr#PrincipalArn" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.ecr#PushTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#PutAccountSetting": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutAccountSettingRequest" }, "output": { "target": "com.amazonaws.ecr#PutAccountSettingResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Allows you to change the basic scan type version or registry policy scope.
" } }, "com.amazonaws.ecr#PutAccountSettingRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.ecr#AccountSettingName", "traits": { "smithy.api#documentation": "The name of the account setting, such as BASIC_SCAN_TYPE_VERSION,\n REGISTRY_POLICY_SCOPE, or BLOB_MOUNTING.
Setting value that is specified. Valid value for basic scan type: AWS_NATIVE.\n Valid values for registry policy scope: V2.\n Valid values for blob mounting: ENABLED or DISABLED.
Retrieves the name of the account setting.
" } }, "value": { "target": "com.amazonaws.ecr#AccountSettingValue", "traits": { "smithy.api#documentation": "Retrieves the value of the specified account setting.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutImage": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutImageRequest" }, "output": { "target": "com.amazonaws.ecr#PutImageResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ImageAlreadyExistsException" }, { "target": "com.amazonaws.ecr#ImageDigestDoesNotMatchException" }, { "target": "com.amazonaws.ecr#ImageTagAlreadyExistsException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#LayersNotFoundException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ReferencedImagesNotFoundException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Creates or updates the image manifest and tags associated with an image.
\nWhen an image is pushed and all new image layers have been uploaded, the PutImage API\n is called once to create or update the image manifest and the tags associated with the\n image.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry that contains the repository in\n which to put the image. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository in which to put the image.
", "smithy.api#required": {} } }, "imageManifest": { "target": "com.amazonaws.ecr#ImageManifest", "traits": { "smithy.api#documentation": "The image manifest corresponding to the image to be uploaded.
", "smithy.api#required": {} } }, "imageManifestMediaType": { "target": "com.amazonaws.ecr#MediaType", "traits": { "smithy.api#documentation": "The media type of the image manifest. If you push an image manifest that does not\n contain the mediaType field, you must specify the\n imageManifestMediaType in the request.
The tag to associate with the image. This parameter is optional.
" } }, "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The image digest of the image manifest corresponding to the image.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutImageResponse": { "type": "structure", "members": { "image": { "target": "com.amazonaws.ecr#Image", "traits": { "smithy.api#documentation": "Details of the image uploaded.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutImageScanningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutImageScanningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#PutImageScanningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "The PutImageScanningConfiguration API is being deprecated, in favor\n of specifying the image scanning configuration at the registry level. For more\n information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
" } }, "com.amazonaws.ecr#PutImageScanningConfigurationRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to update the image scanning configuration setting.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository in which to update the image scanning configuration\n setting.
", "smithy.api#required": {} } }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "The image scanning configuration for the repository. This setting determines whether\n images are scanned for known vulnerabilities after being pushed to the\n repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutImageScanningConfigurationResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration", "traits": { "smithy.api#documentation": "The image scanning configuration setting for the repository.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutImageTagMutability": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutImageTagMutabilityRequest" }, "output": { "target": "com.amazonaws.ecr#PutImageTagMutabilityResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Updates the image tag mutability settings for the specified repository. For more\n information, see Image tag\n mutability in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#PutImageTagMutabilityRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository in which to update the image tag mutability\n settings.
", "smithy.api#required": {} } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The tag mutability setting for the repository. If MUTABLE is specified,\n image tags can be overwritten. If IMMUTABLE is specified, all image tags\n within the repository will be immutable which will prevent them from being\n overwritten.
A list of filters that specify which image tags should be excluded from the image tag\n mutability setting being applied.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutImageTagMutabilityResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The image tag mutability setting for the repository.
" } }, "imageTagMutabilityExclusionFilters": { "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", "traits": { "smithy.api#documentation": "The list of filters that specify which image tags are excluded from the repository's\n image tag mutability setting.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.ecr#PutLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates the lifecycle policy for the specified repository. For more\n information, see Lifecycle policy\n template.
" } }, "com.amazonaws.ecr#PutLifecyclePolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository. If you\n do\u2028 not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to receive the policy.
", "smithy.api#required": {} } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text to apply to the repository.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutLifecyclePolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutRegistryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutRegistryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#PutRegistryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates the permissions policy for your registry.
\nA registry policy is used to specify permissions for another Amazon Web Services account and is used\n when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#PutRegistryPolicyRequest": { "type": "structure", "members": { "policyText": { "target": "com.amazonaws.ecr#RegistryPolicyText", "traits": { "smithy.api#documentation": "The JSON policy text to apply to your registry. The policy text follows the same\n format as IAM policy text. For more information, see Registry\n permissions in the Amazon Elastic Container Registry User Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutRegistryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RegistryPolicyText", "traits": { "smithy.api#documentation": "The JSON policy text for your registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutRegistryScanningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#BlockedByOrganizationPolicyException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates the scanning configuration for your private registry.
" } }, "com.amazonaws.ecr#PutRegistryScanningConfigurationRequest": { "type": "structure", "members": { "scanType": { "target": "com.amazonaws.ecr#ScanType", "traits": { "smithy.api#documentation": "The scanning type to set for the registry.
\nWhen a registry scanning configuration is not defined, by default the\n BASIC scan type is used. When basic scanning is used, you may specify\n filters to determine which individual repositories, or all repositories, are scanned\n when new images are pushed to those repositories. Alternatively, you can do manual scans\n of images with basic scanning.
When the ENHANCED scan type is set, Amazon Inspector provides automated\n vulnerability scanning. You may choose between continuous scanning or scan on push and\n you may specify filters to determine which individual repositories, or all repositories,\n are scanned.
The scanning rules to use for the registry. A scanning rule is used to determine which\n repository filters are used and at what frequency scanning will occur.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutRegistryScanningConfigurationResponse": { "type": "structure", "members": { "registryScanningConfiguration": { "target": "com.amazonaws.ecr#RegistryScanningConfiguration", "traits": { "smithy.api#documentation": "The scanning configuration for your registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutReplicationConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutReplicationConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#PutReplicationConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates the replication configuration for a registry. The existing\n replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the\n PutReplicationConfiguration API is called, a service-linked IAM role is created in\n your account for the replication process. For more information, see Using\n service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.\n For more information on the custom role for replication, see Creating an IAM role for replication.
\nWhen configuring cross-account replication, the destination account must grant the\n source account permission to replicate. This permission is controlled using a\n registry permissions policy. For more information, see PutRegistryPolicy.
\nAn object representing the replication configuration for a registry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutReplicationConfigurationResponse": { "type": "structure", "members": { "replicationConfiguration": { "target": "com.amazonaws.ecr#ReplicationConfiguration", "traits": { "smithy.api#documentation": "The contents of the replication configuration for the registry.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#PutSigningConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.ecr#PutSigningConfigurationRequest" }, "output": { "target": "com.amazonaws.ecr#PutSigningConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates or updates the registry's signing configuration, which defines\n rules for automatically signing images with Amazon Web Services Signer.
\nFor more information, see Managed signing in the\n Amazon Elastic Container Registry User Guide.
\nTo successfully generate a signature, the IAM principal pushing images must have\n permission to sign payloads with the Amazon Web Services Signer signing profile referenced in the signing\n configuration.
\nThe signing configuration to assign to the registry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#PutSigningConfigurationResponse": { "type": "structure", "members": { "signingConfiguration": { "target": "com.amazonaws.ecr#SigningConfiguration", "traits": { "smithy.api#documentation": "The registry's updated signing configuration.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#RCTAppliedFor": { "type": "enum", "members": { "REPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPLICATION" } }, "PULL_THROUGH_CACHE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PULL_THROUGH_CACHE" } }, "CREATE_ON_PUSH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_ON_PUSH" } } } }, "com.amazonaws.ecr#RCTAppliedForList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RCTAppliedFor" } }, "com.amazonaws.ecr#Reason": { "type": "string" }, "com.amazonaws.ecr#Recommendation": { "type": "structure", "members": { "url": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The URL address to the CVE remediation recommendations.
" } }, "text": { "target": "com.amazonaws.ecr#RecommendationText", "traits": { "smithy.api#documentation": "The recommended course of action to remediate the finding.
" } } }, "traits": { "smithy.api#documentation": "Details about the recommended course of action to remediate the finding.
" } }, "com.amazonaws.ecr#RecommendationText": { "type": "string" }, "com.amazonaws.ecr#RecordedPullTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#ReferenceUrlsList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Url" } }, "com.amazonaws.ecr#ReferencedImagesNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The manifest list is referencing an image that does not exist.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#Region": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 25 }, "smithy.api#pattern": "^[0-9a-z-]{2,25}$" } }, "com.amazonaws.ecr#RegisterPullTimeUpdateExclusion": { "type": "operation", "input": { "target": "com.amazonaws.ecr#RegisterPullTimeUpdateExclusionRequest" }, "output": { "target": "com.amazonaws.ecr#RegisterPullTimeUpdateExclusionResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ExclusionAlreadyExistsException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds an IAM principal to the pull time update exclusion list for a registry. Amazon ECR will not record the pull time if an excluded principal pulls an image.
" } }, "com.amazonaws.ecr#RegisterPullTimeUpdateExclusionRequest": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.ecr#PrincipalArn", "traits": { "smithy.api#documentation": "The ARN of the IAM principal to exclude from having image pull times recorded.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#RegisterPullTimeUpdateExclusionResponse": { "type": "structure", "members": { "principalArn": { "target": "com.amazonaws.ecr#PrincipalArn", "traits": { "smithy.api#documentation": "The ARN of the IAM principal that was added to the pull time update exclusion list.
" } }, "createdAt": { "target": "com.amazonaws.ecr#CreationTimestamp", "traits": { "smithy.api#documentation": "The date and time, expressed in standard JavaScript date format, when the exclusion was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#RegistryId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.ecr#RegistryPolicyNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The registry doesn't have an associated registry policy.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#RegistryPolicyText": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 10240 } } }, "com.amazonaws.ecr#RegistryScanningConfiguration": { "type": "structure", "members": { "scanType": { "target": "com.amazonaws.ecr#ScanType", "traits": { "smithy.api#documentation": "The type of scanning configured for the registry.
" } }, "rules": { "target": "com.amazonaws.ecr#RegistryScanningRuleList", "traits": { "smithy.api#documentation": "The scanning rules associated with the registry.
" } } }, "traits": { "smithy.api#documentation": "The scanning configuration for a private registry.
" } }, "com.amazonaws.ecr#RegistryScanningRule": { "type": "structure", "members": { "scanFrequency": { "target": "com.amazonaws.ecr#ScanFrequency", "traits": { "smithy.api#documentation": "The frequency that scans are performed at for a private registry. When the\n ENHANCED scan type is specified, the supported scan frequencies are\n CONTINUOUS_SCAN and SCAN_ON_PUSH. When the\n BASIC scan type is specified, the SCAN_ON_PUSH scan\n frequency is supported. If scan on push is not specified, then the MANUAL\n scan frequency is set by default.
The repository filters associated with the scanning configuration for a private\n registry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of a scanning rule for a private registry.
" } }, "com.amazonaws.ecr#RegistryScanningRuleList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RegistryScanningRule" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.ecr#RelatedVulnerabilitiesList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RelatedVulnerability" } }, "com.amazonaws.ecr#RelatedVulnerability": { "type": "string" }, "com.amazonaws.ecr#Release": { "type": "string" }, "com.amazonaws.ecr#Remediation": { "type": "structure", "members": { "recommendation": { "target": "com.amazonaws.ecr#Recommendation", "traits": { "smithy.api#documentation": "An object that contains information about the recommended course of action to\n remediate the finding.
" } } }, "traits": { "smithy.api#documentation": "Information on how to remediate a finding.
" } }, "com.amazonaws.ecr#ReplicationBackfillError": { "type": "string" }, "com.amazonaws.ecr#ReplicationBackfillId": { "type": "string", "traits": { "smithy.api#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}$" } }, "com.amazonaws.ecr#ReplicationBackfillInProgressException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "A replication backfill is already in progress for the specified destination Region.\n This occurs because only one replication backfill can be in progress for a given\n destination Region at a time. Wait for the in progress backfill to reach a terminal\n status, or stop it with the StopReplicationBackfill operation, before\n starting another one.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ReplicationBackfillInvalidStatusException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The requested operation can't be performed on the replication backfill because it is\n not in a valid status for that operation. For example, you can't stop a replication\n backfill that has already reached a terminal status. Use the DescribeReplicationBackfillResults operation to check the current status\n before retrying.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ReplicationBackfillNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified replication backfill could not be found. Check the specified replication\n backfill ID and ensure that you are operating on the correct registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ReplicationBackfillProgress": { "type": "structure", "members": { "totalReplicationCount": { "target": "com.amazonaws.ecr#NonNegativeInteger", "traits": { "smithy.api#documentation": "The total number of replications that the backfill will perform. Each image and tag\n combination is counted as a single replication.
", "smithy.api#required": {} } }, "completedReplicationCount": { "target": "com.amazonaws.ecr#NonNegativeInteger", "traits": { "smithy.api#documentation": "The number of replications that have completed successfully.
", "smithy.api#required": {} } }, "failedReplicationCount": { "target": "com.amazonaws.ecr#NonNegativeInteger", "traits": { "smithy.api#documentation": "The number of replications that have failed.
", "smithy.api#required": {} } }, "failureCodes": { "target": "com.amazonaws.ecr#ReplicationErrorList", "traits": { "smithy.api#documentation": "The distinct failure codes for the replications that have failed. Each failure code\n appears at most once, regardless of how many replications failed with that code.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object representing the progress of a replication backfill, including the total,\n completed, and failed replication counts.
" } }, "com.amazonaws.ecr#ReplicationBackfillResult": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that contains the image.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#documentation": "An object with identifying information for the image.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ecr#ReplicationBackfillResultStatus", "traits": { "smithy.api#documentation": "The replication status of the image.
", "smithy.api#required": {} } }, "failureCode": { "target": "com.amazonaws.ecr#ReplicationError", "traits": { "smithy.api#documentation": "The failure code for a replication that has failed.
" } }, "subImageFailureCodes": { "target": "com.amazonaws.ecr#ReplicationErrorList", "traits": { "smithy.api#documentation": "The distinct failure codes for the images referenced by a manifest list that failed to\n replicate. Each failure code appears at most once, regardless of how many referenced\n images failed with that code. This field is present only when the image is a manifest\n list.
" } } }, "traits": { "smithy.api#documentation": "An object representing the result of a single replication during a replication\n backfill. Each image and tag combination is replicated as a single replication.
" } }, "com.amazonaws.ecr#ReplicationBackfillResultList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ReplicationBackfillResult" } }, "com.amazonaws.ecr#ReplicationBackfillResultStatus": { "type": "enum", "members": { "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.ecr#ReplicationBackfillStatus": { "type": "enum", "members": { "PREPARING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREPARING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } } }, "com.amazonaws.ecr#ReplicationBackfillSummary": { "type": "structure", "members": { "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill.
", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.ecr#ReplicationDestination", "traits": { "smithy.api#documentation": "The destination Region and registry to which the images are replicated.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.ecr#ReplicationBackfillStatus", "traits": { "smithy.api#documentation": "The current status of the replication backfill.
", "smithy.api#required": {} } }, "failureCode": { "target": "com.amazonaws.ecr#ReplicationBackfillError", "traits": { "smithy.api#documentation": "The failure code for a replication backfill that has failed.
" } }, "progress": { "target": "com.amazonaws.ecr#ReplicationBackfillProgress", "traits": { "smithy.api#documentation": "The progress of the replication backfill, including the total, completed, and failed\n replication counts. This value is null until the replication backfill\n finishes preparing the set of images to replicate. It is therefore null\n while the replication backfill is PREPARING, and remains null\n if the replication backfill is stopped before preparation completes.
The date and time, in JavaScript date format, when the replication backfill was\n started.
", "smithy.api#required": {} } }, "endedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the replication backfill ended.\n This value is null while the replication backfill is still in\n progress.
An object representing a summary of a replication backfill, including its status,\n destination, progress, and start and end times.
" } }, "com.amazonaws.ecr#ReplicationBackfillSummaryList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ReplicationBackfillSummary" } }, "com.amazonaws.ecr#ReplicationConfiguration": { "type": "structure", "members": { "rules": { "target": "com.amazonaws.ecr#ReplicationRuleList", "traits": { "smithy.api#documentation": "An array of objects representing the replication destinations and repository filters\n for a replication configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The replication configuration for a registry.
" } }, "com.amazonaws.ecr#ReplicationDestination": { "type": "structure", "members": { "region": { "target": "com.amazonaws.ecr#Region", "traits": { "smithy.api#documentation": "The Region to replicate to.
", "smithy.api#required": {} } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring\n cross-Region replication within your own registry, specify your own account ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An array of objects representing the destination for a replication rule.
" } }, "com.amazonaws.ecr#ReplicationDestinationList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ReplicationDestination" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.ecr#ReplicationError": { "type": "string" }, "com.amazonaws.ecr#ReplicationErrorList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ReplicationError" } }, "com.amazonaws.ecr#ReplicationRule": { "type": "structure", "members": { "destinations": { "target": "com.amazonaws.ecr#ReplicationDestinationList", "traits": { "smithy.api#documentation": "An array of objects representing the destination for a replication rule.
", "smithy.api#required": {} } }, "repositoryFilters": { "target": "com.amazonaws.ecr#RepositoryFilterList", "traits": { "smithy.api#documentation": "An array of objects representing the filters for a replication rule. Specifying a\n repository filter for a replication rule provides a method for controlling which\n repositories in a private registry are replicated.
" } }, "deleteReplication": { "target": "com.amazonaws.ecr#DeleteReplication", "traits": { "smithy.api#documentation": "The delete replication settings for the replication rule. When delete replication is\n enabled, the service replicates image deletions and image tag removals from the source\n registry to the replication destinations. If you do not specify this parameter, the\n service does not replicate image deletions or image tag removals for the replication\n rule.
" } } }, "traits": { "smithy.api#documentation": "An array of objects representing the replication destinations and repository filters\n for a replication configuration.
" } }, "com.amazonaws.ecr#ReplicationRuleList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ReplicationRule" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.ecr#ReplicationStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.ecr#Repository": { "type": "structure", "members": { "repositoryArn": { "target": "com.amazonaws.ecr#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the\n repository, Amazon Web Services account ID of the repository owner, and repository name.\n For example, arn:aws:ecr:region:012345678910:repository/repository-name.
The Amazon Web Services account ID associated with the registry that contains the repository.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
" } }, "repositoryUri": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The URI for the repository. You can use this URI for container image push\n and pull operations.
The date and time, in JavaScript date format, when the repository was created.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The tag mutability setting for the repository.
" } }, "imageTagMutabilityExclusionFilters": { "target": "com.amazonaws.ecr#ImageTagMutabilityExclusionFilters", "traits": { "smithy.api#documentation": "A list of filters that specify which image tags are excluded from the repository's\n image tag mutability setting.
" } }, "imageScanningConfiguration": { "target": "com.amazonaws.ecr#ImageScanningConfiguration" }, "encryptionConfiguration": { "target": "com.amazonaws.ecr#EncryptionConfiguration", "traits": { "smithy.api#documentation": "The encryption configuration for the repository. This determines how the contents of\n your repository are encrypted at rest.
" } } }, "traits": { "smithy.api#documentation": "An object representing a repository.
" } }, "com.amazonaws.ecr#RepositoryAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified repository already exists in the specified registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#RepositoryCreationTemplate": { "type": "structure", "members": { "prefix": { "target": "com.amazonaws.ecr#Prefix", "traits": { "smithy.api#documentation": "The repository namespace prefix associated with the repository creation\n template.
" } }, "description": { "target": "com.amazonaws.ecr#RepositoryTemplateDescription", "traits": { "smithy.api#documentation": "The description associated with the repository creation template.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The encryption configuration associated with the repository creation template.
" } }, "resourceTags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The metadata to apply to the repository to help you categorize and organize. Each tag\n 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\n a maximum length of 256 characters.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "The tag mutability setting for the repository. If this parameter is omitted, the\n default setting of MUTABLE will be used which will allow image tags to be\n overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.
A list of filters that specify which image tags are excluded from the repository\n creation template's image tag mutability setting.
" } }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The repository policy to apply to repositories created using the template. A\n repository policy is a permissions policy associated with a repository to control access\n permissions.
" } }, "lifecyclePolicy": { "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The lifecycle policy to use for repositories created using the template.
" } }, "appliedFor": { "target": "com.amazonaws.ecr#RCTAppliedForList", "traits": { "smithy.api#documentation": "A list of enumerable Strings representing the repository creation scenarios that this\n template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and\n CREATE_ON_PUSH
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role\n when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.
" } }, "createdAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the repository creation template\n was created.
" } }, "updatedAt": { "target": "com.amazonaws.ecr#Date", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the repository creation template\n was last updated.
" } } }, "traits": { "smithy.api#documentation": "The details of the repository creation template associated with the request.
" } }, "com.amazonaws.ecr#RepositoryCreationTemplateList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryCreationTemplate" } }, "com.amazonaws.ecr#RepositoryFilter": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.ecr#RepositoryFilterValue", "traits": { "smithy.api#documentation": "The repository filter details. When the PREFIX_MATCH filter type is\n specified, this value is required and should be the repository name prefix to configure\n replication for.
The repository filter type. The only supported value is PREFIX_MATCH,\n which is a repository name prefix specified with the filter\n parameter.
The filter settings used with image replication. Specifying a repository filter to a\n replication rule provides a method for controlling which repositories in a private\n registry are replicated. If no filters are added, the contents of all repositories are\n replicated.
" } }, "com.amazonaws.ecr#RepositoryFilterList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#RepositoryFilterType": { "type": "enum", "members": { "PREFIX_MATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREFIX_MATCH" } } } }, "com.amazonaws.ecr#RepositoryFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 256 }, "smithy.api#pattern": "^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$" } }, "com.amazonaws.ecr#RepositoryList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Repository" } }, "com.amazonaws.ecr#RepositoryName": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 256 }, "smithy.api#pattern": "^[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*(\\/[a-z0-9]+((\\.|_|__|-+)[a-z0-9]+)*)*$" } }, "com.amazonaws.ecr#RepositoryNameList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryName" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#RepositoryNotEmptyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified repository contains images. To delete a repository that contains images,\n you must force the deletion with the force parameter.
The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified repository could not be found. Check the spelling of the specified\n repository and ensure that you are performing operations on the correct registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#RepositoryPolicyNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified repository and registry combination does not have an associated\n repository policy.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#RepositoryPolicyText": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 10240 } } }, "com.amazonaws.ecr#RepositoryScanningConfiguration": { "type": "structure", "members": { "repositoryArn": { "target": "com.amazonaws.ecr#Arn", "traits": { "smithy.api#documentation": "The ARN of the repository.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
" } }, "scanOnPush": { "target": "com.amazonaws.ecr#ScanOnPushFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Whether or not scan on push is configured for the repository.
" } }, "scanFrequency": { "target": "com.amazonaws.ecr#ScanFrequency", "traits": { "smithy.api#documentation": "The scan frequency for the repository.
" } }, "appliedScanFilters": { "target": "com.amazonaws.ecr#ScanningRepositoryFilterList", "traits": { "smithy.api#documentation": "The scan filters applied to the repository.
" } } }, "traits": { "smithy.api#documentation": "The details of the scanning configuration for a repository.
" } }, "com.amazonaws.ecr#RepositoryScanningConfigurationFailure": { "type": "structure", "members": { "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository.
" } }, "failureCode": { "target": "com.amazonaws.ecr#ScanningConfigurationFailureCode", "traits": { "smithy.api#documentation": "The failure code.
" } }, "failureReason": { "target": "com.amazonaws.ecr#ScanningConfigurationFailureReason", "traits": { "smithy.api#documentation": "The reason for the failure.
" } } }, "traits": { "smithy.api#documentation": "The details about any failures associated with the scanning configuration of a\n repository.
" } }, "com.amazonaws.ecr#RepositoryScanningConfigurationFailureList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryScanningConfigurationFailure" } }, "com.amazonaws.ecr#RepositoryScanningConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryScanningConfiguration" } }, "com.amazonaws.ecr#RepositoryTemplateDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.ecr#Resource": { "type": "structure", "members": { "details": { "target": "com.amazonaws.ecr#ResourceDetails", "traits": { "smithy.api#documentation": "An object that contains details about the resource involved in a finding.
" } }, "id": { "target": "com.amazonaws.ecr#ResourceId", "traits": { "smithy.api#documentation": "The ID of the resource.
" } }, "tags": { "target": "com.amazonaws.ecr#Tags", "traits": { "smithy.api#documentation": "The tags attached to the resource.
" } }, "type": { "target": "com.amazonaws.ecr#Type", "traits": { "smithy.api#documentation": "The type of resource.
" } } }, "traits": { "smithy.api#documentation": "Details about the resource involved in a finding.
" } }, "com.amazonaws.ecr#ResourceDetails": { "type": "structure", "members": { "awsEcrContainerImage": { "target": "com.amazonaws.ecr#AwsEcrContainerImageDetails", "traits": { "smithy.api#documentation": "An object that contains details about the Amazon ECR container image involved in the\n finding.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the resource involved in the finding.
" } }, "com.amazonaws.ecr#ResourceId": { "type": "string" }, "com.amazonaws.ecr#ResourceList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Resource" } }, "com.amazonaws.ecr#ScanFrequency": { "type": "enum", "members": { "SCAN_ON_PUSH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCAN_ON_PUSH" } }, "CONTINUOUS_SCAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTINUOUS_SCAN" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } } } }, "com.amazonaws.ecr#ScanNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified image scan could not be found. Ensure that image scanning is enabled on\n the repository and try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ScanOnPushFlag": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.ecr#ScanStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "UNSUPPORTED_IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_IMAGE" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "SCAN_ELIGIBILITY_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCAN_ELIGIBILITY_EXPIRED" } }, "FINDINGS_UNAVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FINDINGS_UNAVAILABLE" } }, "LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LIMIT_EXCEEDED" } }, "IMAGE_ARCHIVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMAGE_ARCHIVED" } }, "IMAGE_SIZE_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMAGE_SIZE_EXCEEDED" } } } }, "com.amazonaws.ecr#ScanStatusDescription": { "type": "string" }, "com.amazonaws.ecr#ScanTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#ScanType": { "type": "enum", "members": { "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } }, "ENHANCED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENHANCED" } } } }, "com.amazonaws.ecr#ScanningConfigurationFailureCode": { "type": "enum", "members": { "REPOSITORY_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPOSITORY_NOT_FOUND" } } } }, "com.amazonaws.ecr#ScanningConfigurationFailureReason": { "type": "string" }, "com.amazonaws.ecr#ScanningConfigurationRepositoryNameList": { "type": "list", "member": { "target": "com.amazonaws.ecr#RepositoryName" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.ecr#ScanningRepositoryFilter": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.ecr#ScanningRepositoryFilterValue", "traits": { "smithy.api#documentation": "The filter to use when scanning.
", "smithy.api#required": {} } }, "filterType": { "target": "com.amazonaws.ecr#ScanningRepositoryFilterType", "traits": { "smithy.api#documentation": "The type associated with the filter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The details of a scanning repository filter. For more information on how to use\n filters, see Using\n filters in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#ScanningRepositoryFilterList": { "type": "list", "member": { "target": "com.amazonaws.ecr#ScanningRepositoryFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.ecr#ScanningRepositoryFilterType": { "type": "enum", "members": { "WILDCARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WILDCARD" } } } }, "com.amazonaws.ecr#ScanningRepositoryFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-z0-9*](?:[._\\-/a-z0-9*]?[a-z0-9*]+)*$" } }, "com.amazonaws.ecr#Score": { "type": "double", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.ecr#ScoreDetails": { "type": "structure", "members": { "cvss": { "target": "com.amazonaws.ecr#CvssScoreDetails", "traits": { "smithy.api#documentation": "An object that contains details about the CVSS score given to a finding.
" } } }, "traits": { "smithy.api#documentation": "Information about the Amazon Inspector score given to a finding.
" } }, "com.amazonaws.ecr#ScoringVector": { "type": "string" }, "com.amazonaws.ecr#SecretNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The ARN of the secret specified in the pull through cache rule was not found. Update\n the pull through cache rule with a valid secret ARN and try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#ServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "These errors are usually caused by a server-side issue.
", "smithy.api#error": "server" } }, "com.amazonaws.ecr#SetRepositoryPolicy": { "type": "operation", "input": { "target": "com.amazonaws.ecr#SetRepositoryPolicyRequest" }, "output": { "target": "com.amazonaws.ecr#SetRepositoryPolicyResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" } ], "traits": { "smithy.api#documentation": "Applies a repository policy to the specified repository to control access permissions.\n For more information, see Amazon ECR Repository\n policies in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#SetRepositoryPolicyRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to receive the policy.
", "smithy.api#required": {} } }, "policyText": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text to apply to the repository. For more information, see\n Amazon ECR repository\n policies in the Amazon Elastic Container Registry User Guide.
", "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.ecr#ForceFlag", "traits": { "smithy.api#default": false, "smithy.api#documentation": "If the policy you are attempting to set on a repository policy would prevent you from\n setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental\n repository lock outs.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#SetRepositoryPolicyResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "policyText": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text applied to the repository.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#Severity": { "type": "string" }, "com.amazonaws.ecr#SeverityCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.ecr#SigningConfiguration": { "type": "structure", "members": { "rules": { "target": "com.amazonaws.ecr#SigningRuleList", "traits": { "smithy.api#documentation": "A list of signing rules. Each rule defines a signing profile and optional repository\n filters that determine which images are automatically signed. Maximum of 10 rules.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The signing configuration for a registry, which specifies rules\n for automatically signing images when pushed.
" } }, "com.amazonaws.ecr#SigningConfigurationNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The specified signing configuration was not found. This occurs when\n attempting to retrieve or delete a signing configuration that does not exist.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#SigningProfileArn": { "type": "string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Signer signing profile. The ARN contains the\n arn:aws:signer namespace, followed by the region, Amazon Web Services account ID, and\n signing profile resource path. For example,\n arn:aws:signer:region:012345678910:/signing-profiles/profile-name.
The filter value used to match repository names. When using\n WILDCARD_MATCH, the * character matches any sequence of characters.
Examples:
\n\n myapp/* - Matches all repositories starting with\n myapp/\n
\n */production - Matches all repositories ending with\n /production\n
\n *prod* - Matches all repositories containing\n prod\n
The type of filter to apply. Currently, only WILDCARD_MATCH is supported,\n which uses wildcard patterns to match repository names.
A repository filter used to determine which repositories have their\n images automatically signed on push. Each filter consists of a filter type and filter value.
" } }, "com.amazonaws.ecr#SigningRepositoryFilterList": { "type": "list", "member": { "target": "com.amazonaws.ecr#SigningRepositoryFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.ecr#SigningRepositoryFilterType": { "type": "enum", "members": { "WILDCARD_MATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WILDCARD_MATCH" } } }, "traits": { "smithy.api#documentation": "The type of filter to use when determining which repositories\n should have their images automatically signed.
" } }, "com.amazonaws.ecr#SigningRepositoryFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^(?:[a-z0-9*]+(?:[._-][a-z0-9*]+)*/)*[a-z0-9*]+(?:[._-][a-z0-9*]+)*$" } }, "com.amazonaws.ecr#SigningRule": { "type": "structure", "members": { "signingProfileArn": { "target": "com.amazonaws.ecr#SigningProfileArn", "traits": { "smithy.api#documentation": "The ARN of the Amazon Web Services Signer signing profile to use for signing images that match this\n rule. For more information about signing profiles, see Signing profiles in\n the Amazon Web Services Signer Developer Guide.
", "smithy.api#required": {} } }, "repositoryFilters": { "target": "com.amazonaws.ecr#SigningRepositoryFilterList", "traits": { "smithy.api#documentation": "A list of repository filters that determine which repositories\n have their images signed on push. If no filters are specified, all\n images pushed to the registry are signed using the rule's signing\n profile. Maximum of 100 filters per rule.
" } } }, "traits": { "smithy.api#documentation": "A signing rule that specifies a signing profile and optional\n repository filters. When an image is pushed to a matching repository, a\n signing job is created using the specified profile.
" } }, "com.amazonaws.ecr#SigningRuleList": { "type": "list", "member": { "target": "com.amazonaws.ecr#SigningRule" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.ecr#SigningStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "The image signing status. Possible values include IN_PROGRESS,\n COMPLETE, and FAILED.
Starts a basic image vulnerability scan.
\nA basic image scan can only be started once per 24 hours on an individual image. This\n limit includes if an image was scanned on initial push. You can start up to 100,000\n basic scans per 24 hours. This limit includes both scans on initial push and scans\n initiated by the StartImageScan API. For more information, see Basic scanning in the Amazon Elastic Container Registry User Guide.
" } }, "com.amazonaws.ecr#StartImageScanRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository in\n which to start an image scan request. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that contains the images to scan.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#StartImageScanResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier" }, "imageScanStatus": { "target": "com.amazonaws.ecr#ImageScanStatus", "traits": { "smithy.api#documentation": "The current state of the scan.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#StartLifecyclePolicyPreview": { "type": "operation", "input": { "target": "com.amazonaws.ecr#StartLifecyclePolicyPreviewRequest" }, "output": { "target": "com.amazonaws.ecr#StartLifecyclePolicyPreviewResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LifecyclePolicyNotFoundException" }, { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewInProgressException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a preview of a lifecycle policy for the specified repository. This allows you\n to see the results before associating the lifecycle policy with the repository.
" } }, "com.amazonaws.ecr#StartLifecyclePolicyPreviewRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the repository.\n If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to be evaluated.
", "smithy.api#required": {} } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The policy to be evaluated against. If you do not specify a policy, the current policy\n for the repository is used.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#StartLifecyclePolicyPreviewResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "lifecyclePolicyText": { "target": "com.amazonaws.ecr#LifecyclePolicyText", "traits": { "smithy.api#documentation": "The JSON repository policy text.
" } }, "status": { "target": "com.amazonaws.ecr#LifecyclePolicyPreviewStatus", "traits": { "smithy.api#documentation": "The status of the lifecycle policy preview request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#StartReplicationBackfill": { "type": "operation", "input": { "target": "com.amazonaws.ecr#StartReplicationBackfillRequest" }, "output": { "target": "com.amazonaws.ecr#StartReplicationBackfillResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#ReplicationBackfillInProgressException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a replication backfill for a registry. A replication backfill replicates a\n registry's existing images that match its replication configuration to the specified\n destination. Use the DescribeReplicationBackfillResults operation to\n monitor the progress of a replication backfill, and to retrieve its per-image results\n after it reaches a terminal status.
\nThe destination must already be configured in the registry's replication\n configuration.
\nOnly one replication backfill can be in progress for a given destination Region at\n a time. Starting a replication backfill for a destination Region that already has one\n in progress fails with a ReplicationBackfillInProgressException. In\n addition, a registry can have at most 10 replication backfills in progress at once.\n Starting a replication backfill that would exceed this limit fails with a\n LimitExceededException.
The Amazon Web Services account ID associated with the registry from which to start the replication\n backfill. If you do not specify a registry, the default registry is assumed.
" } }, "destination": { "target": "com.amazonaws.ecr#ReplicationDestination", "traits": { "smithy.api#documentation": "The destination Region and registry to which the images are replicated.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#StartReplicationBackfillResponse": { "type": "structure", "members": { "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill that was started. Use this value to describe or\n stop the backfill.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "destination": { "target": "com.amazonaws.ecr#ReplicationDestination", "traits": { "smithy.api#documentation": "The destination Region and registry to which the images are replicated.
" } }, "status": { "target": "com.amazonaws.ecr#ReplicationBackfillStatus", "traits": { "smithy.api#documentation": "The current status of the replication backfill. A newly started replication backfill\n is returned with a status of PREPARING.
The date and time, in JavaScript date format, when the replication backfill was\n started.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#Status": { "type": "string" }, "com.amazonaws.ecr#StopReplicationBackfill": { "type": "operation", "input": { "target": "com.amazonaws.ecr#StopReplicationBackfillRequest" }, "output": { "target": "com.amazonaws.ecr#StopReplicationBackfillResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ReplicationBackfillInvalidStatusException" }, { "target": "com.amazonaws.ecr#ReplicationBackfillNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops an in progress replication backfill for a registry. The backfill to stop is\n identified by the replicationBackfillId returned by the StartReplicationBackfill operation.
Images that have already been replicated are not affected, and replications that\n are already in progress continue to completion.
\nThe Amazon Web Services account ID associated with the registry that contains the replication\n backfill to stop. If you do not specify a registry, the default registry is assumed.
" } }, "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill to stop.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#StopReplicationBackfillResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "replicationBackfillId": { "target": "com.amazonaws.ecr#ReplicationBackfillId", "traits": { "smithy.api#documentation": "The ID of the replication backfill.
" } }, "destination": { "target": "com.amazonaws.ecr#ReplicationDestination", "traits": { "smithy.api#documentation": "The destination Region and registry to which the images are replicated.
" } }, "status": { "target": "com.amazonaws.ecr#ReplicationBackfillStatus", "traits": { "smithy.api#documentation": "The current status of the replication backfill. When you stop a replication backfill,\n its status is STOPPED if the backfill is stopped immediately, or\n STOPPING if there are replications still in progress that must complete\n before the backfill stops.
The date and time, in JavaScript date format, when the replication backfill was\n started.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#String": { "type": "string" }, "com.amazonaws.ecr#SubjectIdentifier": { "type": "structure", "members": { "imageDigest": { "target": "com.amazonaws.ecr#ImageDigest", "traits": { "smithy.api#documentation": "The digest of the image.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An object that identifies an image subject.
" } }, "com.amazonaws.ecr#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.ecr#TagKey", "traits": { "smithy.api#documentation": "One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.
A value acts as a descriptor within a tag category (key).
The metadata to apply to a resource to help you categorize and organize them. Each tag\n 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\n a maximum length of 256 characters.
" } }, "com.amazonaws.ecr#TagKey": { "type": "string" }, "com.amazonaws.ecr#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.ecr#TagKey" } }, "com.amazonaws.ecr#TagList": { "type": "list", "member": { "target": "com.amazonaws.ecr#Tag" } }, "com.amazonaws.ecr#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.ecr#TagResourceRequest" }, "output": { "target": "com.amazonaws.ecr#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#InvalidTagParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Adds specified tags to a resource with the specified ARN. Existing tags on a resource\n are not changed if they are not specified in the request parameters.
" } }, "com.amazonaws.ecr#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ecr#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported\n resource is an Amazon ECR repository.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#TagStatus": { "type": "enum", "members": { "TAGGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAGGED" } }, "UNTAGGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNTAGGED" } }, "ANY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY" } } } }, "com.amazonaws.ecr#TagValue": { "type": "string" }, "com.amazonaws.ecr#Tags": { "type": "map", "key": { "target": "com.amazonaws.ecr#TagKey" }, "value": { "target": "com.amazonaws.ecr#TagValue" } }, "com.amazonaws.ecr#TargetStorageClass": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } }, "ARCHIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHIVE" } } } }, "com.amazonaws.ecr#TemplateAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The repository creation template already exists. Specify a unique prefix and try\n again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#TemplateNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified repository creation template can't be found. Verify the registry ID and\n prefix and try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#Title": { "type": "string" }, "com.amazonaws.ecr#TooManyTagsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The list of tags on the repository is over the limit. The maximum number of tags that\n can be applied to a repository is 50.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#TransitioningImageTotalCount": { "type": "structure", "members": { "targetStorageClass": { "target": "com.amazonaws.ecr#LifecyclePolicyTargetStorageClass", "traits": { "smithy.api#documentation": "The target storage class.
" } }, "imageTotalCount": { "target": "com.amazonaws.ecr#ImageCount", "traits": { "smithy.api#documentation": "The total number of images transitioning to the storage class.
" } } }, "traits": { "smithy.api#documentation": "The total count of images transitioning to a storage class.
" } }, "com.amazonaws.ecr#TransitioningImageTotalCounts": { "type": "list", "member": { "target": "com.amazonaws.ecr#TransitioningImageTotalCount" } }, "com.amazonaws.ecr#Type": { "type": "string" }, "com.amazonaws.ecr#UnableToAccessSecretException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The secret is unable to be accessed. Verify the resource permissions for the secret\n and try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnableToDecryptSecretValueException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The secret is accessible but is unable to be decrypted. Verify the resource\n permisisons and try again.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnableToGetUpstreamImageException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The image or images were unable to be pulled using the pull through cache rule. This\n is usually caused because of an issue with the Secrets Manager secret containing the credentials\n for the upstream registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnableToGetUpstreamLayerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "There was an issue getting the upstream layer matching the pull through cache\n rule.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnableToListUpstreamImageReferrersException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The referrer or referrers were unable to be listed using the pull through cache rule. This\n is usually caused because of an issue with the Secrets Manager secret containing the credentials\n for the upstream registry.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnsupportedImageTypeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The image is of a type that cannot be scanned.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UnsupportedUpstreamRegistryException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified upstream registry isn't supported.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.ecr#UntagResourceRequest" }, "output": { "target": "com.amazonaws.ecr#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#InvalidTagParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#TooManyTagsException" } ], "traits": { "smithy.api#documentation": "Deletes specified tags from a resource.
" } }, "com.amazonaws.ecr#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.ecr#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported\n resource is an Amazon ECR repository.
", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.ecr#TagKeyList", "traits": { "smithy.api#documentation": "The keys of the tags to be removed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#UpdateImageStorageClass": { "type": "operation", "input": { "target": "com.amazonaws.ecr#UpdateImageStorageClassRequest" }, "output": { "target": "com.amazonaws.ecr#UpdateImageStorageClassResponse" }, "errors": [ { "target": "com.amazonaws.ecr#ImageNotFoundException" }, { "target": "com.amazonaws.ecr#ImageStorageClassUpdateNotSupportedException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Transitions an image between storage classes. You can transition images from Amazon ECR standard storage class to Amazon ECR archival storage class for long-term storage, or restore archived images back to Amazon ECR standard.
", "smithy.api#examples": [ { "title": "To transition an image to Amazon ECR Archive", "documentation": "This example transitions an image with a specific digest in the hello-repository repository to Amazon ECR Archive storage for long-term archival.", "input": { "registryId": "724772093679", "repositoryName": "hello-repository", "imageId": { "imageDigest": "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b" }, "targetStorageClass": "ARCHIVE" }, "output": { "registryId": "724772093679", "repositoryName": "hello-repository", "imageId": { "imageDigest": "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b" }, "imageStatus": "ARCHIVED" } }, { "title": "To restore an archived image to Amazon ECR Standard", "documentation": "This example restores an archived image with a specific digest back to Amazon ECR Standard storage.", "input": { "registryId": "724772093679", "repositoryName": "hello-repository", "imageId": { "imageDigest": "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b" }, "targetStorageClass": "STANDARD" }, "output": { "registryId": "724772093679", "repositoryName": "hello-repository", "imageId": { "imageDigest": "sha256:0b1a4e0c81c434fa7928e5c4a2651a521ebabc4ff200c65f7e25b99373efca3b" }, "imageStatus": "ACTIVATING" } } ] } }, "com.amazonaws.ecr#UpdateImageStorageClassRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry that contains the image to transition. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository that contains the image to transition.
", "smithy.api#required": {} } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier", "traits": { "smithy.api#required": {} } }, "targetStorageClass": { "target": "com.amazonaws.ecr#TargetStorageClass", "traits": { "smithy.api#documentation": "The target storage class for the image.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#UpdateImageStorageClassResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "imageId": { "target": "com.amazonaws.ecr#ImageIdentifier" }, "imageStatus": { "target": "com.amazonaws.ecr#ImageStatus", "traits": { "smithy.api#documentation": "The current status of the image after the call to UpdateImageStorageClass is complete. Valid values are ACTIVE, ARCHIVED, and ACTIVATING.
Updates an existing pull through cache rule.
" } }, "com.amazonaws.ecr#UpdatePullThroughCacheRuleRequest": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID associated with the registry associated with the pull through\n cache rule. If you do not specify a registry, the default registry is assumed.
" } }, "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The repository name prefix to use when caching images from the source registry.
", "smithy.api#required": {} } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate\n to the upstream registry.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to\n the ECR upstream registry. This role must be in the same account as the registry that\n you are configuring.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#UpdatePullThroughCacheRuleResponse": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "updatedAt": { "target": "com.amazonaws.ecr#UpdatedTimestamp", "traits": { "smithy.api#documentation": "The date and time, in JavaScript date format, when the pull through cache rule was\n updated.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the pull through cache rule.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The upstream repository prefix associated with the pull through cache rule.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#UpdateRepositoryCreationTemplate": { "type": "operation", "input": { "target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplateRequest" }, "output": { "target": "com.amazonaws.ecr#UpdateRepositoryCreationTemplateResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#TemplateNotFoundException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an existing repository creation template.
" } }, "com.amazonaws.ecr#UpdateRepositoryCreationTemplateRequest": { "type": "structure", "members": { "prefix": { "target": "com.amazonaws.ecr#Prefix", "traits": { "smithy.api#documentation": "The repository namespace prefix that matches an existing repository creation template\n in the registry. All repositories created using this namespace prefix will have the\n settings defined in this template applied. For example, a prefix of prod\n would apply to all repositories beginning with prod/. This includes a\n repository named prod/team1 as well as a repository named\n prod/repository1.
To apply a template to all repositories in your registry that don't have an associated\n creation template, you can use ROOT as the prefix.
A description for the repository creation template.
" } }, "encryptionConfiguration": { "target": "com.amazonaws.ecr#EncryptionConfigurationForRepositoryCreationTemplate" }, "resourceTags": { "target": "com.amazonaws.ecr#TagList", "traits": { "smithy.api#documentation": "The metadata to apply to the repository to help you categorize and organize. Each tag\n 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\n a maximum length of 256 characters.
" } }, "imageTagMutability": { "target": "com.amazonaws.ecr#ImageTagMutability", "traits": { "smithy.api#documentation": "Updates the tag mutability setting for the repository. If this parameter is omitted,\n the default setting of MUTABLE will be used which will allow image tags to\n be overwritten. If IMMUTABLE is specified, all image tags within the\n repository will be immutable which will prevent them from being overwritten.
A list of filters that specify which image tags should be excluded from the repository\n creation template's image tag mutability setting.
" } }, "repositoryPolicy": { "target": "com.amazonaws.ecr#RepositoryPolicyText", "traits": { "smithy.api#documentation": "Updates the repository policy created using the template. A repository policy is a\n permissions policy associated with a repository to control access permissions.
" } }, "lifecyclePolicy": { "target": "com.amazonaws.ecr#LifecyclePolicyTextForRepositoryCreationTemplate", "traits": { "smithy.api#documentation": "Updates the lifecycle policy associated with the specified repository creation\n template.
" } }, "appliedFor": { "target": "com.amazonaws.ecr#RCTAppliedForList", "traits": { "smithy.api#documentation": "Updates the list of enumerable strings representing the Amazon ECR repository creation\n scenarios that this template will apply towards. The supported scenarios are\n PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH\n
The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as\n the registry that you are configuring. Amazon ECR will assume your supplied role when the\n customRoleArn is specified. When this field isn't specified, Amazon ECR will use the\n service-linked role for the repository creation template.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#UpdateRepositoryCreationTemplateResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryCreationTemplate": { "target": "com.amazonaws.ecr#RepositoryCreationTemplate", "traits": { "smithy.api#documentation": "The details of the repository creation template associated with the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#UpdatedTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#UploadId": { "type": "string", "traits": { "smithy.api#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}$" } }, "com.amazonaws.ecr#UploadLayerPart": { "type": "operation", "input": { "target": "com.amazonaws.ecr#UploadLayerPartRequest" }, "output": { "target": "com.amazonaws.ecr#UploadLayerPartResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidLayerPartException" }, { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#KmsException" }, { "target": "com.amazonaws.ecr#LimitExceededException" }, { "target": "com.amazonaws.ecr#RepositoryNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#UploadNotFoundException" } ], "traits": { "smithy.api#documentation": "Uploads an image layer part to Amazon ECR.
\nWhen an image is pushed, each new image layer is uploaded in parts. The maximum size\n of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API\n is called once per each new image layer part.
\nThis operation is used by the Amazon ECR proxy and is not generally used by\n customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
The Amazon Web Services account ID associated with the registry to which you are uploading layer\n parts. If you do not specify a registry, the default registry is assumed.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The name of the repository to which you are uploading layer parts.
", "smithy.api#required": {} } }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID from a previous InitiateLayerUpload operation to\n associate with the layer part upload.
", "smithy.api#required": {} } }, "partFirstByte": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "The position of the first byte of the layer part witin the overall image layer.
", "smithy.api#required": {} } }, "partLastByte": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "The position of the last byte of the layer part within the overall image layer.
", "smithy.api#required": {} } }, "layerPartBlob": { "target": "com.amazonaws.ecr#LayerPartBlob", "traits": { "smithy.api#documentation": "The base64-encoded layer part payload.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#UploadLayerPartResponse": { "type": "structure", "members": { "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "repositoryName": { "target": "com.amazonaws.ecr#RepositoryName", "traits": { "smithy.api#documentation": "The repository name associated with the request.
" } }, "uploadId": { "target": "com.amazonaws.ecr#UploadId", "traits": { "smithy.api#documentation": "The upload ID associated with the request.
" } }, "lastByteReceived": { "target": "com.amazonaws.ecr#PartSize", "traits": { "smithy.api#documentation": "The integer value of the last byte received in the request.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#UploadNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage", "traits": { "smithy.api#documentation": "The error message associated with the exception.
" } } }, "traits": { "smithy.api#documentation": "The upload could not be found, or the specified upload ID is not valid for this\n repository.
", "smithy.api#error": "client" } }, "com.amazonaws.ecr#UpstreamRegistry": { "type": "enum", "members": { "Ecr": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ecr" } }, "EcrPublic": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ecr-public" } }, "Quay": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "quay" } }, "K8s": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "k8s" } }, "DockerHub": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "docker-hub" } }, "GitHubContainerRegistry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "github-container-registry" } }, "AzureContainerRegistry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "azure-container-registry" } }, "GitLabContainerRegistry": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gitlab-container-registry" } }, "Chainguard": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "chainguard" } } } }, "com.amazonaws.ecr#Url": { "type": "string" }, "com.amazonaws.ecr#ValidatePullThroughCacheRule": { "type": "operation", "input": { "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest" }, "output": { "target": "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse" }, "errors": [ { "target": "com.amazonaws.ecr#InvalidParameterException" }, { "target": "com.amazonaws.ecr#PullThroughCacheRuleNotFoundException" }, { "target": "com.amazonaws.ecr#ServerException" }, { "target": "com.amazonaws.ecr#ValidationException" } ], "traits": { "smithy.api#documentation": "Validates an existing pull through cache rule for an upstream registry that requires\n authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the\n syntax, and then validate that authentication to the upstream registry is\n successful.
" } }, "com.amazonaws.ecr#ValidatePullThroughCacheRuleRequest": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The repository name prefix associated with the pull through cache rule.
", "smithy.api#required": {} } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the pull through cache rule.\n If you do not specify a registry, the default registry is assumed.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.ecr#ValidatePullThroughCacheRuleResponse": { "type": "structure", "members": { "ecrRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The Amazon ECR repository prefix associated with the pull through cache rule.
" } }, "registryId": { "target": "com.amazonaws.ecr#RegistryId", "traits": { "smithy.api#documentation": "The registry ID associated with the request.
" } }, "upstreamRegistryUrl": { "target": "com.amazonaws.ecr#Url", "traits": { "smithy.api#documentation": "The upstream registry URL associated with the pull through cache rule.
" } }, "credentialArn": { "target": "com.amazonaws.ecr#CredentialArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache\n rule.
" } }, "customRoleArn": { "target": "com.amazonaws.ecr#CustomRoleArn", "traits": { "smithy.api#documentation": "The ARN of the IAM role associated with the pull through cache rule.
" } }, "upstreamRepositoryPrefix": { "target": "com.amazonaws.ecr#PullThroughCacheRuleRepositoryPrefix", "traits": { "smithy.api#documentation": "The upstream repository prefix associated with the pull through cache rule.
" } }, "isValid": { "target": "com.amazonaws.ecr#IsPTCRuleValid", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Whether or not the pull through cache rule was validated. If true, Amazon ECR\n was able to reach the upstream registry and authentication was successful. If\n false, there was an issue and validation failed. The\n failure reason indicates the cause.
The reason the validation failed. For more details about possible causes and how to\n address them, see Using pull through cache\n rules in the Amazon Elastic Container Registry User Guide.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.ecr#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.ecr#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "There was an exception validating this request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.ecr#Version": { "type": "string" }, "com.amazonaws.ecr#VulnerabilityId": { "type": "string" }, "com.amazonaws.ecr#VulnerabilitySourceUpdateTimestamp": { "type": "timestamp" }, "com.amazonaws.ecr#VulnerablePackage": { "type": "structure", "members": { "arch": { "target": "com.amazonaws.ecr#Arch", "traits": { "smithy.api#documentation": "The architecture of the vulnerable package.
" } }, "epoch": { "target": "com.amazonaws.ecr#Epoch", "traits": { "smithy.api#documentation": "The epoch of the vulnerable package.
" } }, "filePath": { "target": "com.amazonaws.ecr#FilePath", "traits": { "smithy.api#documentation": "The file path of the vulnerable package.
" } }, "name": { "target": "com.amazonaws.ecr#VulnerablePackageName", "traits": { "smithy.api#documentation": "The name of the vulnerable package.
" } }, "packageManager": { "target": "com.amazonaws.ecr#PackageManager", "traits": { "smithy.api#documentation": "The package manager of the vulnerable package.
" } }, "release": { "target": "com.amazonaws.ecr#Release", "traits": { "smithy.api#documentation": "The release of the vulnerable package.
" } }, "sourceLayerHash": { "target": "com.amazonaws.ecr#SourceLayerHash", "traits": { "smithy.api#documentation": "The source layer hash of the vulnerable package.
" } }, "version": { "target": "com.amazonaws.ecr#Version", "traits": { "smithy.api#documentation": "The version of the vulnerable package.
" } }, "fixedInVersion": { "target": "com.amazonaws.ecr#FixedInVersion", "traits": { "smithy.api#documentation": "The version of the package that contains the vulnerability fix.
" } } }, "traits": { "smithy.api#documentation": "Information on the vulnerable package identified by a finding.
" } }, "com.amazonaws.ecr#VulnerablePackageName": { "type": "string" }, "com.amazonaws.ecr#VulnerablePackagesList": { "type": "list", "member": { "target": "com.amazonaws.ecr#VulnerablePackage" } } } }