# Data Types
<a name="API_Types"></a>

The Amazon Elastic Container Registry API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [Attribute](API_Attribute.md) 
+  [AuthorizationData](API_AuthorizationData.md) 
+  [AwsEcrContainerImageDetails](API_AwsEcrContainerImageDetails.md) 
+  [CvssScore](API_CvssScore.md) 
+  [CvssScoreAdjustment](API_CvssScoreAdjustment.md) 
+  [CvssScoreDetails](API_CvssScoreDetails.md) 
+  [DescribeImagesFilter](API_DescribeImagesFilter.md) 
+  [EncryptionConfiguration](API_EncryptionConfiguration.md) 
+  [EncryptionConfigurationForRepositoryCreationTemplate](API_EncryptionConfigurationForRepositoryCreationTemplate.md) 
+  [EnhancedImageScanFinding](API_EnhancedImageScanFinding.md) 
+  [Image](API_Image.md) 
+  [ImageDetail](API_ImageDetail.md) 
+  [ImageFailure](API_ImageFailure.md) 
+  [ImageIdentifier](API_ImageIdentifier.md) 
+  [ImageReferrer](API_ImageReferrer.md) 
+  [ImageReplicationStatus](API_ImageReplicationStatus.md) 
+  [ImageScanFinding](API_ImageScanFinding.md) 
+  [ImageScanFindings](API_ImageScanFindings.md) 
+  [ImageScanFindingsSummary](API_ImageScanFindingsSummary.md) 
+  [ImageScanningConfiguration](API_ImageScanningConfiguration.md) 
+  [ImageScanStatus](API_ImageScanStatus.md) 
+  [ImageSigningStatus](API_ImageSigningStatus.md) 
+  [ImageTagMutabilityExclusionFilter](API_ImageTagMutabilityExclusionFilter.md) 
+  [Layer](API_Layer.md) 
+  [LayerFailure](API_LayerFailure.md) 
+  [LifecyclePolicyPreviewFilter](API_LifecyclePolicyPreviewFilter.md) 
+  [LifecyclePolicyPreviewResult](API_LifecyclePolicyPreviewResult.md) 
+  [LifecyclePolicyPreviewSummary](API_LifecyclePolicyPreviewSummary.md) 
+  [LifecyclePolicyRuleAction](API_LifecyclePolicyRuleAction.md) 
+  [ListImageReferrersFilter](API_ListImageReferrersFilter.md) 
+  [ListImagesFilter](API_ListImagesFilter.md) 
+  [PackageVulnerabilityDetails](API_PackageVulnerabilityDetails.md) 
+  [PullThroughCacheRule](API_PullThroughCacheRule.md) 
+  [Recommendation](API_Recommendation.md) 
+  [RegistryScanningConfiguration](API_RegistryScanningConfiguration.md) 
+  [RegistryScanningRule](API_RegistryScanningRule.md) 
+  [Remediation](API_Remediation.md) 
+  [ReplicationConfiguration](API_ReplicationConfiguration.md) 
+  [ReplicationDestination](API_ReplicationDestination.md) 
+  [ReplicationRule](API_ReplicationRule.md) 
+  [Repository](API_Repository.md) 
+  [RepositoryCreationTemplate](API_RepositoryCreationTemplate.md) 
+  [RepositoryFilter](API_RepositoryFilter.md) 
+  [RepositoryScanningConfiguration](API_RepositoryScanningConfiguration.md) 
+  [RepositoryScanningConfigurationFailure](API_RepositoryScanningConfigurationFailure.md) 
+  [Resource](API_Resource.md) 
+  [ResourceDetails](API_ResourceDetails.md) 
+  [ScanningRepositoryFilter](API_ScanningRepositoryFilter.md) 
+  [ScoreDetails](API_ScoreDetails.md) 
+  [SigningConfiguration](API_SigningConfiguration.md) 
+  [SigningRepositoryFilter](API_SigningRepositoryFilter.md) 
+  [SigningRule](API_SigningRule.md) 
+  [SubjectIdentifier](API_SubjectIdentifier.md) 
+  [Tag](API_Tag.md) 
+  [TransitioningImageTotalCount](API_TransitioningImageTotalCount.md) 
+  [VulnerablePackage](API_VulnerablePackage.md) 

# Attribute
<a name="API_Attribute"></a>

This data type is used in the [ImageScanFinding](API_ImageScanFinding.md) data type.

## Contents
<a name="API_Attribute_Contents"></a>

 ** key **   <a name="ECR-Type-Attribute-key"></a>
The attribute key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** value **   <a name="ECR-Type-Attribute-value"></a>
The value assigned to the attribute key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## See Also
<a name="API_Attribute_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Attribute) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Attribute) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Attribute) 

# AuthorizationData
<a name="API_AuthorizationData"></a>

An object representing authorization data for an Amazon ECR registry.

## Contents
<a name="API_AuthorizationData_Contents"></a>

 ** authorizationToken **   <a name="ECR-Type-AuthorizationData-authorizationToken"></a>
A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format `user:password` for private registry authentication using `docker login`.  
Type: String  
Pattern: `^\S+$`   
Required: No

 ** expiresAt **   <a name="ECR-Type-AuthorizationData-expiresAt"></a>
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.  
Type: Timestamp  
Required: No

 ** proxyEndpoint **   <a name="ECR-Type-AuthorizationData-proxyEndpoint"></a>
The registry URL to use for this authorization token in a `docker login` command. The Amazon ECR registry URL format is `https://aws_account_id.dkr.ecr.region.amazonaws.com`. For example, `https://012345678910.dkr.ecr.us-east-1.amazonaws.com`..   
Type: String  
Required: No

## See Also
<a name="API_AuthorizationData_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/AuthorizationData) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/AuthorizationData) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/AuthorizationData) 

# AwsEcrContainerImageDetails
<a name="API_AwsEcrContainerImageDetails"></a>

The image details of the Amazon ECR container image.

## Contents
<a name="API_AwsEcrContainerImageDetails_Contents"></a>

 ** architecture **   <a name="ECR-Type-AwsEcrContainerImageDetails-architecture"></a>
The architecture of the Amazon ECR container image.  
Type: String  
Required: No

 ** author **   <a name="ECR-Type-AwsEcrContainerImageDetails-author"></a>
The image author of the Amazon ECR container image.  
Type: String  
Required: No

 ** imageHash **   <a name="ECR-Type-AwsEcrContainerImageDetails-imageHash"></a>
The image hash of the Amazon ECR container image.  
Type: String  
Required: No

 ** imageTags **   <a name="ECR-Type-AwsEcrContainerImageDetails-imageTags"></a>
The image tags attached to the Amazon ECR container image.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** inUseCount **   <a name="ECR-Type-AwsEcrContainerImageDetails-inUseCount"></a>
The number of Amazon ECS or Amazon EKS clusters currently running the image.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** lastInUseAt **   <a name="ECR-Type-AwsEcrContainerImageDetails-lastInUseAt"></a>
The most recent date and time a cluster was running the image.  
Type: Timestamp  
Required: No

 ** platform **   <a name="ECR-Type-AwsEcrContainerImageDetails-platform"></a>
The platform of the Amazon ECR container image.  
Type: String  
Required: No

 ** pushedAt **   <a name="ECR-Type-AwsEcrContainerImageDetails-pushedAt"></a>
The date and time the Amazon ECR container image was pushed.  
Type: Timestamp  
Required: No

 ** registry **   <a name="ECR-Type-AwsEcrContainerImageDetails-registry"></a>
The registry the Amazon ECR container image belongs to.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** repositoryName **   <a name="ECR-Type-AwsEcrContainerImageDetails-repositoryName"></a>
The name of the repository the Amazon ECR container image resides in.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

## See Also
<a name="API_AwsEcrContainerImageDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/AwsEcrContainerImageDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/AwsEcrContainerImageDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/AwsEcrContainerImageDetails) 

# CvssScore
<a name="API_CvssScore"></a>

The CVSS score for a finding.

## Contents
<a name="API_CvssScore_Contents"></a>

 ** baseScore **   <a name="ECR-Type-CvssScore-baseScore"></a>
The base CVSS score used for the finding.  
Type: Double  
Required: No

 ** scoringVector **   <a name="ECR-Type-CvssScore-scoringVector"></a>
The vector string of the CVSS score.  
Type: String  
Required: No

 ** source **   <a name="ECR-Type-CvssScore-source"></a>
The source of the CVSS score.  
Type: String  
Required: No

 ** version **   <a name="ECR-Type-CvssScore-version"></a>
The version of CVSS used for the score.  
Type: String  
Required: No

## See Also
<a name="API_CvssScore_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/CvssScore) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/CvssScore) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/CvssScore) 

# CvssScoreAdjustment
<a name="API_CvssScoreAdjustment"></a>

Details on adjustments Amazon Inspector made to the CVSS score for a finding.

## Contents
<a name="API_CvssScoreAdjustment_Contents"></a>

 ** metric **   <a name="ECR-Type-CvssScoreAdjustment-metric"></a>
The metric used to adjust the CVSS score.  
Type: String  
Required: No

 ** reason **   <a name="ECR-Type-CvssScoreAdjustment-reason"></a>
The reason the CVSS score has been adjustment.  
Type: String  
Required: No

## See Also
<a name="API_CvssScoreAdjustment_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/CvssScoreAdjustment) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/CvssScoreAdjustment) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/CvssScoreAdjustment) 

# CvssScoreDetails
<a name="API_CvssScoreDetails"></a>

Information about the CVSS score.

## Contents
<a name="API_CvssScoreDetails_Contents"></a>

 ** adjustments **   <a name="ECR-Type-CvssScoreDetails-adjustments"></a>
An object that contains details about adjustment Amazon Inspector made to the CVSS score.  
Type: Array of [CvssScoreAdjustment](API_CvssScoreAdjustment.md) objects  
Required: No

 ** score **   <a name="ECR-Type-CvssScoreDetails-score"></a>
The CVSS score.  
Type: Double  
Required: No

 ** scoreSource **   <a name="ECR-Type-CvssScoreDetails-scoreSource"></a>
The source for the CVSS score.  
Type: String  
Required: No

 ** scoringVector **   <a name="ECR-Type-CvssScoreDetails-scoringVector"></a>
The vector for the CVSS score.  
Type: String  
Required: No

 ** version **   <a name="ECR-Type-CvssScoreDetails-version"></a>
The CVSS version used in scoring.  
Type: String  
Required: No

## See Also
<a name="API_CvssScoreDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/CvssScoreDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/CvssScoreDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/CvssScoreDetails) 

# DescribeImagesFilter
<a name="API_DescribeImagesFilter"></a>

An object representing a filter on a [DescribeImages](API_DescribeImages.md) operation.

## Contents
<a name="API_DescribeImagesFilter_Contents"></a>

 ** imageStatus **   <a name="ECR-Type-DescribeImagesFilter-imageStatus"></a>
The image status with which to filter your [DescribeImages](API_DescribeImages.md) results. Valid values are `ACTIVE`, `ARCHIVED`, and `ACTIVATING`. If not specified, only images with `ACTIVE` status are returned.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | ACTIVATING | ANY`   
Required: No

 ** tagStatus **   <a name="ECR-Type-DescribeImagesFilter-tagStatus"></a>
The tag status with which to filter your [DescribeImages](API_DescribeImages.md) results. You can filter results based on whether they are `TAGGED` or `UNTAGGED`.  
Type: String  
Valid Values: `TAGGED | UNTAGGED | ANY`   
Required: No

## See Also
<a name="API_DescribeImagesFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/DescribeImagesFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/DescribeImagesFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/DescribeImagesFilter) 

# EncryptionConfiguration
<a name="API_EncryptionConfiguration"></a>

The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

By default, when no encryption configuration is set or the `AES256` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES256 encryption algorithm. This does not require any action on your part.

For more control over the encryption of the contents of your repository, you can use server-side encryption with Amazon Key Management Service key stored in Amazon Key Management Service (Amazon KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.amazonaws.cn/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.

## Contents
<a name="API_EncryptionConfiguration_Contents"></a>

 ** encryptionType **   <a name="ECR-Type-EncryptionConfiguration-encryptionType"></a>
The encryption type to use.  
If you use the `KMS` encryption type, the contents of the repository will be encrypted using server-side encryption with Amazon Key Management Service key stored in Amazon KMS. When you use Amazon KMS to encrypt your data, you can either use the default Amazon managed Amazon KMS key for Amazon ECR, or specify your own Amazon KMS key, which you already created.  
If you use the `KMS_DSSE` encryption type, the contents of the repository will be encrypted with two layers of encryption using server-side encryption with the Amazon KMS Management Service key stored in Amazon KMS. Similar to the `KMS` encryption type, you can either use the default Amazon managed Amazon KMS key for Amazon ECR, or specify your own Amazon KMS key, which you've already created.   
If you use the `AES256` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm.  
For more information, see [Amazon ECR encryption at rest](https://docs.amazonaws.cn/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.  
Type: String  
Valid Values: `AES256 | KMS | KMS_DSSE`   
Required: Yes

 ** kmsKey **   <a name="ECR-Type-EncryptionConfiguration-kmsKey"></a>
If you use the `KMS` encryption type, specify the Amazon KMS key to use for encryption. The alias, key ID, or full ARN of the Amazon KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon managed Amazon KMS key for Amazon ECR will be used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## See Also
<a name="API_EncryptionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/EncryptionConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/EncryptionConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/EncryptionConfiguration) 

# EncryptionConfigurationForRepositoryCreationTemplate
<a name="API_EncryptionConfigurationForRepositoryCreationTemplate"></a>

The encryption configuration to associate with the repository creation template.

## Contents
<a name="API_EncryptionConfigurationForRepositoryCreationTemplate_Contents"></a>

 ** encryptionType **   <a name="ECR-Type-EncryptionConfigurationForRepositoryCreationTemplate-encryptionType"></a>
The encryption type to use.  
If you use the `KMS` encryption type, the contents of the repository will be encrypted using server-side encryption with Amazon Key Management Service key stored in Amazon KMS. When you use Amazon KMS to encrypt your data, you can either use the default Amazon managed Amazon KMS key for Amazon ECR, or specify your own Amazon KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an Amazon KMS key stored in Amazon Key Management Service (SSE-KMS)](https://docs.amazonaws.cn/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.  
If you use the `AES256` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.amazonaws.cn/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*.  
Type: String  
Valid Values: `AES256 | KMS | KMS_DSSE`   
Required: Yes

 ** kmsKey **   <a name="ECR-Type-EncryptionConfigurationForRepositoryCreationTemplate-kmsKey"></a>
If you use the `KMS` encryption type, specify the Amazon KMS key to use for encryption. The full ARN of the Amazon KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon managed Amazon KMS key for Amazon ECR will be used.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `^$|arn:aws[a-z0-9-]*:kms:[a-z0-9-]+:[0-9]{12}:key\/[a-z0-9-]+`   
Required: No

## See Also
<a name="API_EncryptionConfigurationForRepositoryCreationTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/EncryptionConfigurationForRepositoryCreationTemplate) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/EncryptionConfigurationForRepositoryCreationTemplate) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/EncryptionConfigurationForRepositoryCreationTemplate) 

# EnhancedImageScanFinding
<a name="API_EnhancedImageScanFinding"></a>

The details of an enhanced image scan. This is returned when enhanced scanning is enabled for your private registry.

## Contents
<a name="API_EnhancedImageScanFinding_Contents"></a>

 ** awsAccountId **   <a name="ECR-Type-EnhancedImageScanFinding-awsAccountId"></a>
The Amazon account ID associated with the image.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** description **   <a name="ECR-Type-EnhancedImageScanFinding-description"></a>
The description of the finding.  
Type: String  
Required: No

 ** exploitAvailable **   <a name="ECR-Type-EnhancedImageScanFinding-exploitAvailable"></a>
If a finding discovered in your environment has an exploit available.  
Type: String  
Required: No

 ** findingArn **   <a name="ECR-Type-EnhancedImageScanFinding-findingArn"></a>
The Amazon Resource Number (ARN) of the finding.  
Type: String  
Required: No

 ** firstObservedAt **   <a name="ECR-Type-EnhancedImageScanFinding-firstObservedAt"></a>
The date and time that the finding was first observed.  
Type: Timestamp  
Required: No

 ** fixAvailable **   <a name="ECR-Type-EnhancedImageScanFinding-fixAvailable"></a>
Details on whether a fix is available through a version update. This value can be `YES`, `NO`, or `PARTIAL`. A `PARTIAL` fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.  
Type: String  
Required: No

 ** lastObservedAt **   <a name="ECR-Type-EnhancedImageScanFinding-lastObservedAt"></a>
The date and time that the finding was last observed.  
Type: Timestamp  
Required: No

 ** packageVulnerabilityDetails **   <a name="ECR-Type-EnhancedImageScanFinding-packageVulnerabilityDetails"></a>
An object that contains the details of a package vulnerability finding.  
Type: [PackageVulnerabilityDetails](API_PackageVulnerabilityDetails.md) object  
Required: No

 ** remediation **   <a name="ECR-Type-EnhancedImageScanFinding-remediation"></a>
An object that contains the details about how to remediate a finding.  
Type: [Remediation](API_Remediation.md) object  
Required: No

 ** resources **   <a name="ECR-Type-EnhancedImageScanFinding-resources"></a>
Contains information on the resources involved in a finding.  
Type: Array of [Resource](API_Resource.md) objects  
Required: No

 ** score **   <a name="ECR-Type-EnhancedImageScanFinding-score"></a>
The Amazon Inspector score given to the finding.  
Type: Double  
Required: No

 ** scoreDetails **   <a name="ECR-Type-EnhancedImageScanFinding-scoreDetails"></a>
An object that contains details of the Amazon Inspector score.  
Type: [ScoreDetails](API_ScoreDetails.md) object  
Required: No

 ** severity **   <a name="ECR-Type-EnhancedImageScanFinding-severity"></a>
The severity of the finding.  
Type: String  
Required: No

 ** status **   <a name="ECR-Type-EnhancedImageScanFinding-status"></a>
The status of the finding.  
Type: String  
Required: No

 ** title **   <a name="ECR-Type-EnhancedImageScanFinding-title"></a>
The title of the finding.  
Type: String  
Required: No

 ** type **   <a name="ECR-Type-EnhancedImageScanFinding-type"></a>
The type of the finding.  
Type: String  
Required: No

 ** updatedAt **   <a name="ECR-Type-EnhancedImageScanFinding-updatedAt"></a>
The date and time the finding was last updated at.  
Type: Timestamp  
Required: No

## See Also
<a name="API_EnhancedImageScanFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/EnhancedImageScanFinding) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/EnhancedImageScanFinding) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/EnhancedImageScanFinding) 

# Image
<a name="API_Image"></a>

An object representing an Amazon ECR image.

## Contents
<a name="API_Image_Contents"></a>

 ** imageId **   <a name="ECR-Type-Image-imageId"></a>
An object containing the image tag and image digest associated with an image.  
Type: [ImageIdentifier](API_ImageIdentifier.md) object  
Required: No

 ** imageManifest **   <a name="ECR-Type-Image-imageManifest"></a>
The image manifest associated with the image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4194304.  
Required: No

 ** imageManifestMediaType **   <a name="ECR-Type-Image-imageManifestMediaType"></a>
The manifest media type of the image.  
Type: String  
Required: No

 ** registryId **   <a name="ECR-Type-Image-registryId"></a>
The Amazon account ID associated with the registry containing the image.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** repositoryName **   <a name="ECR-Type-Image-repositoryName"></a>
The name of the repository associated with the image.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

## See Also
<a name="API_Image_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Image) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Image) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Image) 

# ImageDetail
<a name="API_ImageDetail"></a>

An object that describes an image returned by a [DescribeImages](API_DescribeImages.md) operation.

## Contents
<a name="API_ImageDetail_Contents"></a>

 ** artifactMediaType **   <a name="ECR-Type-ImageDetail-artifactMediaType"></a>
The artifact media type of the image.  
Type: String  
Required: No

 ** imageDigest **   <a name="ECR-Type-ImageDetail-imageDigest"></a>
The `sha256` digest of the image manifest.  
Type: String  
Required: No

 ** imageManifestMediaType **   <a name="ECR-Type-ImageDetail-imageManifestMediaType"></a>
The media type of the image manifest.  
Type: String  
Required: No

 ** imagePushedAt **   <a name="ECR-Type-ImageDetail-imagePushedAt"></a>
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.   
Type: Timestamp  
Required: No

 ** imageScanFindingsSummary **   <a name="ECR-Type-ImageDetail-imageScanFindingsSummary"></a>
A summary of the last completed image scan.  
Type: [ImageScanFindingsSummary](API_ImageScanFindingsSummary.md) object  
Required: No

 ** imageScanStatus **   <a name="ECR-Type-ImageDetail-imageScanStatus"></a>
The current state of the scan.  
Type: [ImageScanStatus](API_ImageScanStatus.md) object  
Required: No

 ** imageSizeInBytes **   <a name="ECR-Type-ImageDetail-imageSizeInBytes"></a>
The size, in bytes, of the image in the repository.  
If the image is a manifest list, this will be the max size of all manifests in the list.  
Starting with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the `docker images` command shows the uncompressed image size. Therefore, Docker might return a larger image than the image shown in the Amazon Web Services Management Console.
Type: Long  
Required: No

 ** imageStatus **   <a name="ECR-Type-ImageDetail-imageStatus"></a>
The current status of the image.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | ACTIVATING`   
Required: No

 ** imageTags **   <a name="ECR-Type-ImageDetail-imageTags"></a>
The list of tags associated with this image.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** lastActivatedAt **   <a name="ECR-Type-ImageDetail-lastActivatedAt"></a>
The date and time, expressed in standard JavaScript date format, when the image was last restored from Amazon ECR archive to Amazon ECR standard.  
Type: Timestamp  
Required: No

 ** lastArchivedAt **   <a name="ECR-Type-ImageDetail-lastArchivedAt"></a>
The date and time, expressed in standard JavaScript date format, when the image was last transitioned to Amazon ECR archive.  
Type: Timestamp  
Required: No

 ** lastRecordedPullTime **   <a name="ECR-Type-ImageDetail-lastRecordedPullTime"></a>
The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.  
Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the `lastRecordedPullTime` timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the `lastRecordedPullTime` timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.
Type: Timestamp  
Required: No

 ** registryId **   <a name="ECR-Type-ImageDetail-registryId"></a>
The Amazon account ID associated with the registry to which this image belongs.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** repositoryName **   <a name="ECR-Type-ImageDetail-repositoryName"></a>
The name of the repository to which this image belongs.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

 ** subjectManifestDigest **   <a name="ECR-Type-ImageDetail-subjectManifestDigest"></a>
The digest of the subject manifest for images that are referrers.  
Type: String  
Required: No

## See Also
<a name="API_ImageDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageDetail) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageDetail) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageDetail) 

# ImageFailure
<a name="API_ImageFailure"></a>

An object representing an Amazon ECR image failure.

## Contents
<a name="API_ImageFailure_Contents"></a>

 ** failureCode **   <a name="ECR-Type-ImageFailure-failureCode"></a>
The code associated with the failure.  
Type: String  
Valid Values: `InvalidImageDigest | InvalidImageTag | ImageTagDoesNotMatchDigest | ImageNotFound | MissingDigestAndTag | ImageReferencedByManifestList | KmsError | UpstreamAccessDenied | UpstreamTooManyRequests | UpstreamUnavailable | ImageInaccessible`   
Required: No

 ** failureReason **   <a name="ECR-Type-ImageFailure-failureReason"></a>
The reason for the failure.  
Type: String  
Required: No

 ** imageId **   <a name="ECR-Type-ImageFailure-imageId"></a>
The image ID associated with the failure.  
Type: [ImageIdentifier](API_ImageIdentifier.md) object  
Required: No

## See Also
<a name="API_ImageFailure_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageFailure) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageFailure) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageFailure) 

# ImageIdentifier
<a name="API_ImageIdentifier"></a>

An object with identifying information for an image in an Amazon ECR repository.

## Contents
<a name="API_ImageIdentifier_Contents"></a>

 ** imageDigest **   <a name="ECR-Type-ImageIdentifier-imageDigest"></a>
The `sha256` digest of the image manifest.  
Type: String  
Required: No

 ** imageTag **   <a name="ECR-Type-ImageIdentifier-imageTag"></a>
The tag used for the image.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

## See Also
<a name="API_ImageIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageIdentifier) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageIdentifier) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageIdentifier) 

# ImageReferrer
<a name="API_ImageReferrer"></a>

An object representing an artifact associated with a subject image.

## Contents
<a name="API_ImageReferrer_Contents"></a>

 ** digest **   <a name="ECR-Type-ImageReferrer-digest"></a>
The digest of the artifact manifest.  
Type: String  
Required: Yes

 ** mediaType **   <a name="ECR-Type-ImageReferrer-mediaType"></a>
The media type of the artifact manifest.  
Type: String  
Required: Yes

 ** size **   <a name="ECR-Type-ImageReferrer-size"></a>
The size, in bytes, of the artifact.  
Type: Long  
Required: Yes

 ** annotations **   <a name="ECR-Type-ImageReferrer-annotations"></a>
A map of annotations associated with the artifact.  
Type: String to string map  
Required: No

 ** artifactStatus **   <a name="ECR-Type-ImageReferrer-artifactStatus"></a>
The status of the artifact. Valid values are `ACTIVE`, `ARCHIVED`, or `ACTIVATING`.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | ACTIVATING`   
Required: No

 ** artifactType **   <a name="ECR-Type-ImageReferrer-artifactType"></a>
A string identifying the type of artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## See Also
<a name="API_ImageReferrer_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageReferrer) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageReferrer) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageReferrer) 

# ImageReplicationStatus
<a name="API_ImageReplicationStatus"></a>

The status of the replication process for an image.

## Contents
<a name="API_ImageReplicationStatus_Contents"></a>

 ** failureCode **   <a name="ECR-Type-ImageReplicationStatus-failureCode"></a>
The failure code for a replication that has failed.  
Type: String  
Required: No

 ** region **   <a name="ECR-Type-ImageReplicationStatus-region"></a>
The destination Region for the image replication.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 25.  
Pattern: `[0-9a-z-]{2,25}`   
Required: No

 ** registryId **   <a name="ECR-Type-ImageReplicationStatus-registryId"></a>
The Amazon account ID associated with the registry to which the image belongs.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** status **   <a name="ECR-Type-ImageReplicationStatus-status"></a>
The image replication status.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED`   
Required: No

## See Also
<a name="API_ImageReplicationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageReplicationStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageReplicationStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageReplicationStatus) 

# ImageScanFinding
<a name="API_ImageScanFinding"></a>

Contains information about an image scan finding.

## Contents
<a name="API_ImageScanFinding_Contents"></a>

 ** attributes **   <a name="ECR-Type-ImageScanFinding-attributes"></a>
A collection of attributes of the host from which the finding is generated.  
Type: Array of [Attribute](API_Attribute.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** description **   <a name="ECR-Type-ImageScanFinding-description"></a>
The description of the finding.  
Type: String  
Required: No

 ** name **   <a name="ECR-Type-ImageScanFinding-name"></a>
The name associated with the finding, usually a CVE number.  
Type: String  
Required: No

 ** severity **   <a name="ECR-Type-ImageScanFinding-severity"></a>
The finding severity.  
Type: String  
Valid Values: `INFORMATIONAL | LOW | MEDIUM | HIGH | CRITICAL | UNDEFINED`   
Required: No

 ** uri **   <a name="ECR-Type-ImageScanFinding-uri"></a>
A link containing additional details about the security vulnerability.  
Type: String  
Required: No

## See Also
<a name="API_ImageScanFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageScanFinding) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageScanFinding) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageScanFinding) 

# ImageScanFindings
<a name="API_ImageScanFindings"></a>

The details of an image scan.

## Contents
<a name="API_ImageScanFindings_Contents"></a>

 ** enhancedFindings **   <a name="ECR-Type-ImageScanFindings-enhancedFindings"></a>
Details about the enhanced scan findings from Amazon Inspector.  
Type: Array of [EnhancedImageScanFinding](API_EnhancedImageScanFinding.md) objects  
Required: No

 ** findings **   <a name="ECR-Type-ImageScanFindings-findings"></a>
The findings from the image scan.  
Type: Array of [ImageScanFinding](API_ImageScanFinding.md) objects  
Required: No

 ** findingSeverityCounts **   <a name="ECR-Type-ImageScanFindings-findingSeverityCounts"></a>
The image vulnerability counts, sorted by severity.  
Type: String to integer map  
Valid Keys: `INFORMATIONAL | LOW | MEDIUM | HIGH | CRITICAL | UNDEFINED`   
Valid Range: Minimum value of 0.  
Required: No

 ** imageScanCompletedAt **   <a name="ECR-Type-ImageScanFindings-imageScanCompletedAt"></a>
The time of the last completed image scan.  
Type: Timestamp  
Required: No

 ** vulnerabilitySourceUpdatedAt **   <a name="ECR-Type-ImageScanFindings-vulnerabilitySourceUpdatedAt"></a>
The time when the vulnerability data was last scanned.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ImageScanFindings_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageScanFindings) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageScanFindings) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageScanFindings) 

# ImageScanFindingsSummary
<a name="API_ImageScanFindingsSummary"></a>

A summary of the last completed image scan.

## Contents
<a name="API_ImageScanFindingsSummary_Contents"></a>

 ** findingSeverityCounts **   <a name="ECR-Type-ImageScanFindingsSummary-findingSeverityCounts"></a>
The image vulnerability counts, sorted by severity.  
Type: String to integer map  
Valid Keys: `INFORMATIONAL | LOW | MEDIUM | HIGH | CRITICAL | UNDEFINED`   
Valid Range: Minimum value of 0.  
Required: No

 ** imageScanCompletedAt **   <a name="ECR-Type-ImageScanFindingsSummary-imageScanCompletedAt"></a>
The time of the last completed image scan.  
Type: Timestamp  
Required: No

 ** vulnerabilitySourceUpdatedAt **   <a name="ECR-Type-ImageScanFindingsSummary-vulnerabilitySourceUpdatedAt"></a>
The time when the vulnerability data was last scanned.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ImageScanFindingsSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageScanFindingsSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageScanFindingsSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageScanFindingsSummary) 

# ImageScanningConfiguration
<a name="API_ImageScanningConfiguration"></a>

The image scanning configuration for a repository.

## Contents
<a name="API_ImageScanningConfiguration_Contents"></a>

 ** scanOnPush **   <a name="ECR-Type-ImageScanningConfiguration-scanOnPush"></a>
The setting that determines whether images are scanned after being pushed to a repository. If set to `true`, images will be scanned after being pushed. If this parameter is not specified, it will default to `false` and images will not be scanned unless a scan is manually started with the [API\$1StartImageScan](https://docs.amazonaws.cn/AmazonECR/latest/APIReference/API_StartImageScan.html) API.  
Type: Boolean  
Required: No

## See Also
<a name="API_ImageScanningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageScanningConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageScanningConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageScanningConfiguration) 

# ImageScanStatus
<a name="API_ImageScanStatus"></a>

The current status of an image scan.

## Contents
<a name="API_ImageScanStatus_Contents"></a>

 ** description **   <a name="ECR-Type-ImageScanStatus-description"></a>
The description of the image scan status.  
Type: String  
Required: No

 ** status **   <a name="ECR-Type-ImageScanStatus-status"></a>
The current state of an image scan.  
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED | UNSUPPORTED_IMAGE | ACTIVE | PENDING | SCAN_ELIGIBILITY_EXPIRED | FINDINGS_UNAVAILABLE | LIMIT_EXCEEDED | IMAGE_ARCHIVED`   
Required: No

## See Also
<a name="API_ImageScanStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageScanStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageScanStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageScanStatus) 

# ImageSigningStatus
<a name="API_ImageSigningStatus"></a>

The signing status for an image. Each status corresponds to a signing profile.

## Contents
<a name="API_ImageSigningStatus_Contents"></a>

 ** failureCode **   <a name="ECR-Type-ImageSigningStatus-failureCode"></a>
The failure code, which is only present if `status` is `FAILED`.  
Type: String  
Required: No

 ** failureReason **   <a name="ECR-Type-ImageSigningStatus-failureReason"></a>
A description of why signing the image failed. This field is only present if `status` is `FAILED`.  
Type: String  
Required: No

 ** signingProfileArn **   <a name="ECR-Type-ImageSigningStatus-signingProfileArn"></a>
The ARN of the Amazon Signer signing profile used to sign the image.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `^arn:aws(-[a-z]+)*:signer:[a-z0-9-]+:[0-9]{12}:\/signing-profiles\/[a-zA-Z0-9_]{2,}$`   
Required: No

 ** status **   <a name="ECR-Type-ImageSigningStatus-status"></a>
The image's signing status. Possible values are:  
+  `IN_PROGRESS` - Signing is currently in progress.
+  `COMPLETE` - The signature was successfully generated.
+  `FAILED` - Signing failed. See `failureCode` and `failureReason` for details.
Type: String  
Valid Values: `IN_PROGRESS | COMPLETE | FAILED`   
Required: No

## See Also
<a name="API_ImageSigningStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageSigningStatus) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageSigningStatus) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageSigningStatus) 

# ImageTagMutabilityExclusionFilter
<a name="API_ImageTagMutabilityExclusionFilter"></a>

A filter that specifies which image tags should be excluded from the repository's image tag mutability setting.

## Contents
<a name="API_ImageTagMutabilityExclusionFilter_Contents"></a>

 ** filter **   <a name="ECR-Type-ImageTagMutabilityExclusionFilter-filter"></a>
The filter value used to match image tags for exclusion from mutability settings.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[0-9a-zA-Z._*-]{1,128}$`   
Required: Yes

 ** filterType **   <a name="ECR-Type-ImageTagMutabilityExclusionFilter-filterType"></a>
The type of filter to apply for excluding image tags from mutability settings.  
Type: String  
Valid Values: `WILDCARD`   
Required: Yes

## See Also
<a name="API_ImageTagMutabilityExclusionFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ImageTagMutabilityExclusionFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ImageTagMutabilityExclusionFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ImageTagMutabilityExclusionFilter) 

# Layer
<a name="API_Layer"></a>

An object representing an Amazon ECR image layer.

## Contents
<a name="API_Layer_Contents"></a>

 ** layerAvailability **   <a name="ECR-Type-Layer-layerAvailability"></a>
The availability status of the image layer.  
Type: String  
Valid Values: `AVAILABLE | UNAVAILABLE | ARCHIVED`   
Required: No

 ** layerDigest **   <a name="ECR-Type-Layer-layerDigest"></a>
The `sha256` digest of the image layer.  
Type: String  
Pattern: `[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+`   
Required: No

 ** layerSize **   <a name="ECR-Type-Layer-layerSize"></a>
The size, in bytes, of the image layer.  
Type: Long  
Required: No

 ** mediaType **   <a name="ECR-Type-Layer-mediaType"></a>
The media type of the layer, such as `application/vnd.docker.image.rootfs.diff.tar.gzip` or `application/vnd.oci.image.layer.v1.tar+gzip`.  
Type: String  
Required: No

## See Also
<a name="API_Layer_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Layer) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Layer) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Layer) 

# LayerFailure
<a name="API_LayerFailure"></a>

An object representing an Amazon ECR image layer failure.

## Contents
<a name="API_LayerFailure_Contents"></a>

 ** failureCode **   <a name="ECR-Type-LayerFailure-failureCode"></a>
The failure code associated with the failure.  
Type: String  
Valid Values: `InvalidLayerDigest | MissingLayerDigest`   
Required: No

 ** failureReason **   <a name="ECR-Type-LayerFailure-failureReason"></a>
The reason for the failure.  
Type: String  
Required: No

 ** layerDigest **   <a name="ECR-Type-LayerFailure-layerDigest"></a>
The layer digest associated with the failure.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## See Also
<a name="API_LayerFailure_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/LayerFailure) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/LayerFailure) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/LayerFailure) 

# LifecyclePolicyPreviewFilter
<a name="API_LifecyclePolicyPreviewFilter"></a>

The filter for the lifecycle policy preview.

## Contents
<a name="API_LifecyclePolicyPreviewFilter_Contents"></a>

 ** tagStatus **   <a name="ECR-Type-LifecyclePolicyPreviewFilter-tagStatus"></a>
The tag status of the image.  
Type: String  
Valid Values: `TAGGED | UNTAGGED | ANY`   
Required: No

## See Also
<a name="API_LifecyclePolicyPreviewFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/LifecyclePolicyPreviewFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/LifecyclePolicyPreviewFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/LifecyclePolicyPreviewFilter) 

# LifecyclePolicyPreviewResult
<a name="API_LifecyclePolicyPreviewResult"></a>

The result of the lifecycle policy preview.

## Contents
<a name="API_LifecyclePolicyPreviewResult_Contents"></a>

 ** action **   <a name="ECR-Type-LifecyclePolicyPreviewResult-action"></a>
The type of action to be taken.  
Type: [LifecyclePolicyRuleAction](API_LifecyclePolicyRuleAction.md) object  
Required: No

 ** appliedRulePriority **   <a name="ECR-Type-LifecyclePolicyPreviewResult-appliedRulePriority"></a>
The priority of the applied rule.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** imageDigest **   <a name="ECR-Type-LifecyclePolicyPreviewResult-imageDigest"></a>
The `sha256` digest of the image manifest.  
Type: String  
Required: No

 ** imagePushedAt **   <a name="ECR-Type-LifecyclePolicyPreviewResult-imagePushedAt"></a>
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.  
Type: Timestamp  
Required: No

 ** imageTags **   <a name="ECR-Type-LifecyclePolicyPreviewResult-imageTags"></a>
The list of tags associated with this image.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 300.  
Required: No

 ** storageClass **   <a name="ECR-Type-LifecyclePolicyPreviewResult-storageClass"></a>
The storage class of the image.  
Type: String  
Valid Values: `ARCHIVE | STANDARD`   
Required: No

## See Also
<a name="API_LifecyclePolicyPreviewResult_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/LifecyclePolicyPreviewResult) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/LifecyclePolicyPreviewResult) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/LifecyclePolicyPreviewResult) 

# LifecyclePolicyPreviewSummary
<a name="API_LifecyclePolicyPreviewSummary"></a>

The summary of the lifecycle policy preview request.

## Contents
<a name="API_LifecyclePolicyPreviewSummary_Contents"></a>

 ** expiringImageTotalCount **   <a name="ECR-Type-LifecyclePolicyPreviewSummary-expiringImageTotalCount"></a>
The number of expiring images.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** transitioningImageTotalCounts **   <a name="ECR-Type-LifecyclePolicyPreviewSummary-transitioningImageTotalCounts"></a>
The total count of images that will be transitioned to each storage class. This field is only present if at least one image will be transitoned in the summary.  
Type: Array of [TransitioningImageTotalCount](API_TransitioningImageTotalCount.md) objects  
Required: No

## See Also
<a name="API_LifecyclePolicyPreviewSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/LifecyclePolicyPreviewSummary) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/LifecyclePolicyPreviewSummary) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/LifecyclePolicyPreviewSummary) 

# LifecyclePolicyRuleAction
<a name="API_LifecyclePolicyRuleAction"></a>

The type of action to be taken.

## Contents
<a name="API_LifecyclePolicyRuleAction_Contents"></a>

 ** targetStorageClass **   <a name="ECR-Type-LifecyclePolicyRuleAction-targetStorageClass"></a>
The target storage class for the action. This is only present when the `type` is `TRANSITION.`   
Type: String  
Valid Values: `ARCHIVE`   
Required: No

 ** type **   <a name="ECR-Type-LifecyclePolicyRuleAction-type"></a>
The type of action to be taken.  
Type: String  
Valid Values: `EXPIRE | TRANSITION`   
Required: No

## See Also
<a name="API_LifecyclePolicyRuleAction_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/LifecyclePolicyRuleAction) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/LifecyclePolicyRuleAction) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/LifecyclePolicyRuleAction) 

# ListImageReferrersFilter
<a name="API_ListImageReferrersFilter"></a>

An object representing a filter on a [ListImageReferrers](API_ListImageReferrers.md) operation.

## Contents
<a name="API_ListImageReferrersFilter_Contents"></a>

 ** artifactStatus **   <a name="ECR-Type-ListImageReferrersFilter-artifactStatus"></a>
The artifact status with which to filter your [ListImageReferrers](API_ListImageReferrers.md) results. Valid values are `ACTIVE`, `ARCHIVED`, `ACTIVATING`, or `ANY`. If not specified, only artifacts with `ACTIVE` status are returned.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | ACTIVATING | ANY`   
Required: No

 ** artifactTypes **   <a name="ECR-Type-ListImageReferrersFilter-artifactTypes"></a>
The artifact types with which to filter your [ListImageReferrers](API_ListImageReferrers.md) results.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## See Also
<a name="API_ListImageReferrersFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ListImageReferrersFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ListImageReferrersFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ListImageReferrersFilter) 

# ListImagesFilter
<a name="API_ListImagesFilter"></a>

An object representing a filter on a [ListImages](API_ListImages.md) operation.

## Contents
<a name="API_ListImagesFilter_Contents"></a>

 ** imageStatus **   <a name="ECR-Type-ListImagesFilter-imageStatus"></a>
The image status with which to filter your [ListImages](API_ListImages.md) results. Valid values are `ACTIVE`, `ARCHIVED`, and `ACTIVATING`. If not specified, only images with `ACTIVE` status are returned.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED | ACTIVATING | ANY`   
Required: No

 ** tagStatus **   <a name="ECR-Type-ListImagesFilter-tagStatus"></a>
The tag status with which to filter your [ListImages](API_ListImages.md) results.  
Type: String  
Valid Values: `TAGGED | UNTAGGED | ANY`   
Required: No

## See Also
<a name="API_ListImagesFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ListImagesFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ListImagesFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ListImagesFilter) 

# PackageVulnerabilityDetails
<a name="API_PackageVulnerabilityDetails"></a>

Information about a package vulnerability finding.

## Contents
<a name="API_PackageVulnerabilityDetails_Contents"></a>

 ** cvss **   <a name="ECR-Type-PackageVulnerabilityDetails-cvss"></a>
An object that contains details about the CVSS score of a finding.  
Type: Array of [CvssScore](API_CvssScore.md) objects  
Required: No

 ** referenceUrls **   <a name="ECR-Type-PackageVulnerabilityDetails-referenceUrls"></a>
One or more URLs that contain details about this vulnerability type.  
Type: Array of strings  
Required: No

 ** relatedVulnerabilities **   <a name="ECR-Type-PackageVulnerabilityDetails-relatedVulnerabilities"></a>
One or more vulnerabilities related to the one identified in this finding.  
Type: Array of strings  
Required: No

 ** source **   <a name="ECR-Type-PackageVulnerabilityDetails-source"></a>
The source of the vulnerability information.  
Type: String  
Required: No

 ** sourceUrl **   <a name="ECR-Type-PackageVulnerabilityDetails-sourceUrl"></a>
A URL to the source of the vulnerability information.  
Type: String  
Required: No

 ** vendorCreatedAt **   <a name="ECR-Type-PackageVulnerabilityDetails-vendorCreatedAt"></a>
The date and time that this vulnerability was first added to the vendor's database.  
Type: Timestamp  
Required: No

 ** vendorSeverity **   <a name="ECR-Type-PackageVulnerabilityDetails-vendorSeverity"></a>
The severity the vendor has given to this vulnerability type.  
Type: String  
Required: No

 ** vendorUpdatedAt **   <a name="ECR-Type-PackageVulnerabilityDetails-vendorUpdatedAt"></a>
The date and time the vendor last updated this vulnerability in their database.  
Type: Timestamp  
Required: No

 ** vulnerabilityId **   <a name="ECR-Type-PackageVulnerabilityDetails-vulnerabilityId"></a>
The ID given to this vulnerability.  
Type: String  
Required: No

 ** vulnerablePackages **   <a name="ECR-Type-PackageVulnerabilityDetails-vulnerablePackages"></a>
The packages impacted by this vulnerability.  
Type: Array of [VulnerablePackage](API_VulnerablePackage.md) objects  
Required: No

## See Also
<a name="API_PackageVulnerabilityDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/PackageVulnerabilityDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/PackageVulnerabilityDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/PackageVulnerabilityDetails) 

# PullThroughCacheRule
<a name="API_PullThroughCacheRule"></a>

The details of a pull through cache rule.

## Contents
<a name="API_PullThroughCacheRule_Contents"></a>

 ** createdAt **   <a name="ECR-Type-PullThroughCacheRule-createdAt"></a>
The date and time the pull through cache was created.  
Type: Timestamp  
Required: No

 ** credentialArn **   <a name="ECR-Type-PullThroughCacheRule-credentialArn"></a>
The ARN of the Secrets Manager secret associated with the pull through cache rule.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 612.  
Pattern: `^arn:aws(-\w+)*:secretsmanager:[a-zA-Z0-9-:]+:secret:ecr\-pullthroughcache\/[a-zA-Z0-9\/_+=.@-]+$`   
Required: No

 ** customRoleArn **   <a name="ECR-Type-PullThroughCacheRule-customRoleArn"></a>
The ARN of the IAM role associated with the pull through cache rule.  
Type: String  
Length Constraints: Maximum length of 2048.  
Required: No

 ** ecrRepositoryPrefix **   <a name="ECR-Type-PullThroughCacheRule-ecrRepositoryPrefix"></a>
The Amazon ECR repository prefix associated with the pull through cache rule.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 30.  
Pattern: `^([a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*\/?|ROOT)$`   
Required: No

 ** registryId **   <a name="ECR-Type-PullThroughCacheRule-registryId"></a>
The Amazon account ID associated with the registry the pull through cache rule is associated with.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** updatedAt **   <a name="ECR-Type-PullThroughCacheRule-updatedAt"></a>
The date and time, in JavaScript date format, when the pull through cache rule was last updated.  
Type: Timestamp  
Required: No

 ** upstreamRegistry **   <a name="ECR-Type-PullThroughCacheRule-upstreamRegistry"></a>
The name of the upstream source registry associated with the pull through cache rule.  
Type: String  
Valid Values: `ecr | ecr-public | quay | k8s | docker-hub | github-container-registry | azure-container-registry | gitlab-container-registry`   
Required: No

 ** upstreamRegistryUrl **   <a name="ECR-Type-PullThroughCacheRule-upstreamRegistryUrl"></a>
The upstream registry URL associated with the pull through cache rule.  
Type: String  
Required: No

 ** upstreamRepositoryPrefix **   <a name="ECR-Type-PullThroughCacheRule-upstreamRepositoryPrefix"></a>
The upstream repository prefix associated with the pull through cache rule.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 30.  
Pattern: `^([a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*\/?|ROOT)$`   
Required: No

## See Also
<a name="API_PullThroughCacheRule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/PullThroughCacheRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/PullThroughCacheRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/PullThroughCacheRule) 

# Recommendation
<a name="API_Recommendation"></a>

Details about the recommended course of action to remediate the finding.

## Contents
<a name="API_Recommendation_Contents"></a>

 ** text **   <a name="ECR-Type-Recommendation-text"></a>
The recommended course of action to remediate the finding.  
Type: String  
Required: No

 ** url **   <a name="ECR-Type-Recommendation-url"></a>
The URL address to the CVE remediation recommendations.  
Type: String  
Required: No

## See Also
<a name="API_Recommendation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Recommendation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Recommendation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Recommendation) 

# RegistryScanningConfiguration
<a name="API_RegistryScanningConfiguration"></a>

The scanning configuration for a private registry.

## Contents
<a name="API_RegistryScanningConfiguration_Contents"></a>

 ** rules **   <a name="ECR-Type-RegistryScanningConfiguration-rules"></a>
The scanning rules associated with the registry.  
Type: Array of [RegistryScanningRule](API_RegistryScanningRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

 ** scanType **   <a name="ECR-Type-RegistryScanningConfiguration-scanType"></a>
The type of scanning configured for the registry.  
Type: String  
Valid Values: `BASIC | ENHANCED`   
Required: No

## See Also
<a name="API_RegistryScanningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RegistryScanningConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RegistryScanningConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RegistryScanningConfiguration) 

# RegistryScanningRule
<a name="API_RegistryScanningRule"></a>

The details of a scanning rule for a private registry.

## Contents
<a name="API_RegistryScanningRule_Contents"></a>

 ** repositoryFilters **   <a name="ECR-Type-RegistryScanningRule-repositoryFilters"></a>
The repository filters associated with the scanning configuration for a private registry.  
Type: Array of [ScanningRepositoryFilter](API_ScanningRepositoryFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: Yes

 ** scanFrequency **   <a name="ECR-Type-RegistryScanningRule-scanFrequency"></a>
The frequency that scans are performed at for a private registry. When the `ENHANCED` scan type is specified, the supported scan frequencies are `CONTINUOUS_SCAN` and `SCAN_ON_PUSH`. When the `BASIC` scan type is specified, the `SCAN_ON_PUSH` scan frequency is supported. If scan on push is not specified, then the `MANUAL` scan frequency is set by default.  
Type: String  
Valid Values: `SCAN_ON_PUSH | CONTINUOUS_SCAN | MANUAL`   
Required: Yes

## See Also
<a name="API_RegistryScanningRule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RegistryScanningRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RegistryScanningRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RegistryScanningRule) 

# Remediation
<a name="API_Remediation"></a>

Information on how to remediate a finding.

## Contents
<a name="API_Remediation_Contents"></a>

 ** recommendation **   <a name="ECR-Type-Remediation-recommendation"></a>
An object that contains information about the recommended course of action to remediate the finding.  
Type: [Recommendation](API_Recommendation.md) object  
Required: No

## See Also
<a name="API_Remediation_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Remediation) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Remediation) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Remediation) 

# ReplicationConfiguration
<a name="API_ReplicationConfiguration"></a>

The replication configuration for a registry.

## Contents
<a name="API_ReplicationConfiguration_Contents"></a>

 ** rules **   <a name="ECR-Type-ReplicationConfiguration-rules"></a>
An array of objects representing the replication destinations and repository filters for a replication configuration.  
Type: Array of [ReplicationRule](API_ReplicationRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: Yes

## See Also
<a name="API_ReplicationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ReplicationConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ReplicationConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ReplicationConfiguration) 

# ReplicationDestination
<a name="API_ReplicationDestination"></a>

An array of objects representing the destination for a replication rule.

## Contents
<a name="API_ReplicationDestination_Contents"></a>

 ** region **   <a name="ECR-Type-ReplicationDestination-region"></a>
The Region to replicate to.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 25.  
Pattern: `[0-9a-z-]{2,25}`   
Required: Yes

 ** registryId **   <a name="ECR-Type-ReplicationDestination-registryId"></a>
The Amazon account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.  
Type: String  
Pattern: `[0-9]{12}`   
Required: Yes

## See Also
<a name="API_ReplicationDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ReplicationDestination) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ReplicationDestination) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ReplicationDestination) 

# ReplicationRule
<a name="API_ReplicationRule"></a>

An array of objects representing the replication destinations and repository filters for a replication configuration.

## Contents
<a name="API_ReplicationRule_Contents"></a>

 ** destinations **   <a name="ECR-Type-ReplicationRule-destinations"></a>
An array of objects representing the destination for a replication rule.  
Type: Array of [ReplicationDestination](API_ReplicationDestination.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: Yes

 ** repositoryFilters **   <a name="ECR-Type-ReplicationRule-repositoryFilters"></a>
An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.  
Type: Array of [RepositoryFilter](API_RepositoryFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

## See Also
<a name="API_ReplicationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ReplicationRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ReplicationRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ReplicationRule) 

# Repository
<a name="API_Repository"></a>

An object representing a repository.

## Contents
<a name="API_Repository_Contents"></a>

 ** createdAt **   <a name="ECR-Type-Repository-createdAt"></a>
The date and time, in JavaScript date format, when the repository was created.  
Type: Timestamp  
Required: No

 ** encryptionConfiguration **   <a name="ECR-Type-Repository-encryptionConfiguration"></a>
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.  
Type: [EncryptionConfiguration](API_EncryptionConfiguration.md) object  
Required: No

 ** imageScanningConfiguration **   <a name="ECR-Type-Repository-imageScanningConfiguration"></a>
The image scanning configuration for a repository.  
Type: [ImageScanningConfiguration](API_ImageScanningConfiguration.md) object  
Required: No

 ** imageTagMutability **   <a name="ECR-Type-Repository-imageTagMutability"></a>
The tag mutability setting for the repository.  
Type: String  
Valid Values: `MUTABLE | IMMUTABLE | IMMUTABLE_WITH_EXCLUSION | MUTABLE_WITH_EXCLUSION`   
Required: No

 ** imageTagMutabilityExclusionFilters **   <a name="ECR-Type-Repository-imageTagMutabilityExclusionFilters"></a>
A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.  
Type: Array of [ImageTagMutabilityExclusionFilter](API_ImageTagMutabilityExclusionFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** registryId **   <a name="ECR-Type-Repository-registryId"></a>
The Amazon account ID associated with the registry that contains the repository.  
Type: String  
Pattern: `[0-9]{12}`   
Required: No

 ** repositoryArn **   <a name="ECR-Type-Repository-repositoryArn"></a>
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the `arn:aws:ecr` namespace, followed by the region of the repository, Amazon account ID of the repository owner, repository namespace, and repository name. For example, `arn:aws:ecr:region:012345678910:repository-namespace/repository-name`.  
Type: String  
Required: No

 ** repositoryName **   <a name="ECR-Type-Repository-repositoryName"></a>
The name of the repository.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

 ** repositoryUri **   <a name="ECR-Type-Repository-repositoryUri"></a>
The URI for the repository. You can use this URI for container image `push` and `pull` operations.  
Type: String  
Required: No

## See Also
<a name="API_Repository_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Repository) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Repository) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Repository) 

# RepositoryCreationTemplate
<a name="API_RepositoryCreationTemplate"></a>

The details of the repository creation template associated with the request.

## Contents
<a name="API_RepositoryCreationTemplate_Contents"></a>

 ** appliedFor **   <a name="ECR-Type-RepositoryCreationTemplate-appliedFor"></a>
A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The supported scenarios are PULL\$1THROUGH\$1CACHE, REPLICATION, and CREATE\$1ON\$1PUSH  
Type: Array of strings  
Valid Values: `REPLICATION | PULL_THROUGH_CACHE | CREATE_ON_PUSH`   
Required: No

 ** createdAt **   <a name="ECR-Type-RepositoryCreationTemplate-createdAt"></a>
The date and time, in JavaScript date format, when the repository creation template was created.  
Type: Timestamp  
Required: No

 ** customRoleArn **   <a name="ECR-Type-RepositoryCreationTemplate-customRoleArn"></a>
The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.  
Type: String  
Length Constraints: Maximum length of 2048.  
Required: No

 ** description **   <a name="ECR-Type-RepositoryCreationTemplate-description"></a>
The description associated with the repository creation template.  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** encryptionConfiguration **   <a name="ECR-Type-RepositoryCreationTemplate-encryptionConfiguration"></a>
The encryption configuration associated with the repository creation template.  
Type: [EncryptionConfigurationForRepositoryCreationTemplate](API_EncryptionConfigurationForRepositoryCreationTemplate.md) object  
Required: No

 ** imageTagMutability **   <a name="ECR-Type-RepositoryCreationTemplate-imageTagMutability"></a>
The tag mutability setting for the repository. If this parameter is omitted, the default setting of `MUTABLE` will be used which will allow image tags to be overwritten. If `IMMUTABLE` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.  
Type: String  
Valid Values: `MUTABLE | IMMUTABLE | IMMUTABLE_WITH_EXCLUSION | MUTABLE_WITH_EXCLUSION`   
Required: No

 ** imageTagMutabilityExclusionFilters **   <a name="ECR-Type-RepositoryCreationTemplate-imageTagMutabilityExclusionFilters"></a>
A list of filters that specify which image tags are excluded from the repository creation template's image tag mutability setting.  
Type: Array of [ImageTagMutabilityExclusionFilter](API_ImageTagMutabilityExclusionFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** lifecyclePolicy **   <a name="ECR-Type-RepositoryCreationTemplate-lifecyclePolicy"></a>
The lifecycle policy to use for repositories created using the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 30720.  
Required: No

 ** prefix **   <a name="ECR-Type-RepositoryCreationTemplate-prefix"></a>
The repository namespace prefix associated with the repository creation template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*\/?|ROOT)$`   
Required: No

 ** repositoryPolicy **   <a name="ECR-Type-RepositoryCreationTemplate-repositoryPolicy"></a>
The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 10240.  
Required: No

 ** resourceTags **   <a name="ECR-Type-RepositoryCreationTemplate-resourceTags"></a>
The metadata to apply to the repository to help you categorize and organize. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** updatedAt **   <a name="ECR-Type-RepositoryCreationTemplate-updatedAt"></a>
The date and time, in JavaScript date format, when the repository creation template was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_RepositoryCreationTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RepositoryCreationTemplate) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RepositoryCreationTemplate) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RepositoryCreationTemplate) 

# RepositoryFilter
<a name="API_RepositoryFilter"></a>

The filter settings used with image replication. Specifying a repository filter to a replication rule provides a method for controlling which repositories in a private registry are replicated. If no filters are added, the contents of all repositories are replicated.

## Contents
<a name="API_RepositoryFilter_Contents"></a>

 ** filter **   <a name="ECR-Type-RepositoryFilter-filter"></a>
The repository filter details. When the `PREFIX_MATCH` filter type is specified, this value is required and should be the repository name prefix to configure replication for.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `^(?:[a-z0-9]+(?:[._-][a-z0-9]*)*/)*[a-z0-9]*(?:[._-][a-z0-9]*)*$`   
Required: Yes

 ** filterType **   <a name="ECR-Type-RepositoryFilter-filterType"></a>
The repository filter type. The only supported value is `PREFIX_MATCH`, which is a repository name prefix specified with the `filter` parameter.  
Type: String  
Valid Values: `PREFIX_MATCH`   
Required: Yes

## See Also
<a name="API_RepositoryFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RepositoryFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RepositoryFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RepositoryFilter) 

# RepositoryScanningConfiguration
<a name="API_RepositoryScanningConfiguration"></a>

The details of the scanning configuration for a repository.

## Contents
<a name="API_RepositoryScanningConfiguration_Contents"></a>

 ** appliedScanFilters **   <a name="ECR-Type-RepositoryScanningConfiguration-appliedScanFilters"></a>
The scan filters applied to the repository.  
Type: Array of [ScanningRepositoryFilter](API_ScanningRepositoryFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** repositoryArn **   <a name="ECR-Type-RepositoryScanningConfiguration-repositoryArn"></a>
The ARN of the repository.  
Type: String  
Required: No

 ** repositoryName **   <a name="ECR-Type-RepositoryScanningConfiguration-repositoryName"></a>
The name of the repository.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

 ** scanFrequency **   <a name="ECR-Type-RepositoryScanningConfiguration-scanFrequency"></a>
The scan frequency for the repository.  
Type: String  
Valid Values: `SCAN_ON_PUSH | CONTINUOUS_SCAN | MANUAL`   
Required: No

 ** scanOnPush **   <a name="ECR-Type-RepositoryScanningConfiguration-scanOnPush"></a>
Whether or not scan on push is configured for the repository.  
Type: Boolean  
Required: No

## See Also
<a name="API_RepositoryScanningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RepositoryScanningConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RepositoryScanningConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RepositoryScanningConfiguration) 

# RepositoryScanningConfigurationFailure
<a name="API_RepositoryScanningConfigurationFailure"></a>

The details about any failures associated with the scanning configuration of a repository.

## Contents
<a name="API_RepositoryScanningConfigurationFailure_Contents"></a>

 ** failureCode **   <a name="ECR-Type-RepositoryScanningConfigurationFailure-failureCode"></a>
The failure code.  
Type: String  
Valid Values: `REPOSITORY_NOT_FOUND`   
Required: No

 ** failureReason **   <a name="ECR-Type-RepositoryScanningConfigurationFailure-failureReason"></a>
The reason for the failure.  
Type: String  
Required: No

 ** repositoryName **   <a name="ECR-Type-RepositoryScanningConfigurationFailure-repositoryName"></a>
The name of the repository.  
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 256.  
Pattern: `[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*`   
Required: No

## See Also
<a name="API_RepositoryScanningConfigurationFailure_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/RepositoryScanningConfigurationFailure) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/RepositoryScanningConfigurationFailure) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/RepositoryScanningConfigurationFailure) 

# Resource
<a name="API_Resource"></a>

Details about the resource involved in a finding.

## Contents
<a name="API_Resource_Contents"></a>

 ** details **   <a name="ECR-Type-Resource-details"></a>
An object that contains details about the resource involved in a finding.  
Type: [ResourceDetails](API_ResourceDetails.md) object  
Required: No

 ** id **   <a name="ECR-Type-Resource-id"></a>
The ID of the resource.  
Type: String  
Required: No

 ** tags **   <a name="ECR-Type-Resource-tags"></a>
The tags attached to the resource.  
Type: String to string map  
Required: No

 ** type **   <a name="ECR-Type-Resource-type"></a>
The type of resource.  
Type: String  
Required: No

## See Also
<a name="API_Resource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Resource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Resource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Resource) 

# ResourceDetails
<a name="API_ResourceDetails"></a>

Contains details about the resource involved in the finding.

## Contents
<a name="API_ResourceDetails_Contents"></a>

 ** awsEcrContainerImage **   <a name="ECR-Type-ResourceDetails-awsEcrContainerImage"></a>
An object that contains details about the Amazon ECR container image involved in the finding.  
Type: [AwsEcrContainerImageDetails](API_AwsEcrContainerImageDetails.md) object  
Required: No

## See Also
<a name="API_ResourceDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ResourceDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ResourceDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ResourceDetails) 

# ScanningRepositoryFilter
<a name="API_ScanningRepositoryFilter"></a>

The details of a scanning repository filter. For more information on how to use filters, see [Using filters](https://docs.amazonaws.cn/AmazonECR/latest/userguide/image-scanning.html#image-scanning-filters) in the *Amazon Elastic Container Registry User Guide*.

## Contents
<a name="API_ScanningRepositoryFilter_Contents"></a>

 ** filter **   <a name="ECR-Type-ScanningRepositoryFilter-filter"></a>
The filter to use when scanning.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-z0-9*](?:[._\-/a-z0-9*]?[a-z0-9*]+)*$`   
Required: Yes

 ** filterType **   <a name="ECR-Type-ScanningRepositoryFilter-filterType"></a>
The type associated with the filter.  
Type: String  
Valid Values: `WILDCARD`   
Required: Yes

## See Also
<a name="API_ScanningRepositoryFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ScanningRepositoryFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ScanningRepositoryFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ScanningRepositoryFilter) 

# ScoreDetails
<a name="API_ScoreDetails"></a>

Information about the Amazon Inspector score given to a finding.

## Contents
<a name="API_ScoreDetails_Contents"></a>

 ** cvss **   <a name="ECR-Type-ScoreDetails-cvss"></a>
An object that contains details about the CVSS score given to a finding.  
Type: [CvssScoreDetails](API_CvssScoreDetails.md) object  
Required: No

## See Also
<a name="API_ScoreDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/ScoreDetails) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/ScoreDetails) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/ScoreDetails) 

# SigningConfiguration
<a name="API_SigningConfiguration"></a>

The signing configuration for a registry, which specifies rules for automatically signing images when pushed.

## Contents
<a name="API_SigningConfiguration_Contents"></a>

 ** rules **   <a name="ECR-Type-SigningConfiguration-rules"></a>
A list of signing rules. Each rule defines a signing profile and optional repository filters that determine which images are automatically signed. Maximum of 10 rules.  
Type: Array of [SigningRule](API_SigningRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: Yes

## See Also
<a name="API_SigningConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/SigningConfiguration) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/SigningConfiguration) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/SigningConfiguration) 

# SigningRepositoryFilter
<a name="API_SigningRepositoryFilter"></a>

A repository filter used to determine which repositories have their images automatically signed on push. Each filter consists of a filter type and filter value.

## Contents
<a name="API_SigningRepositoryFilter_Contents"></a>

 ** filter **   <a name="ECR-Type-SigningRepositoryFilter-filter"></a>
The filter value used to match repository names. When using `WILDCARD_MATCH`, the `*` character matches any sequence of characters.  
Examples:  
+  `myapp/*` - Matches all repositories starting with `myapp/` 
+  `*/production` - Matches all repositories ending with `/production` 
+  `*prod*` - Matches all repositories containing `prod` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(?:[a-z0-9*]+(?:[._-][a-z0-9*]+)*/)*[a-z0-9*]+(?:[._-][a-z0-9*]+)*$`   
Required: Yes

 ** filterType **   <a name="ECR-Type-SigningRepositoryFilter-filterType"></a>
The type of filter to apply. Currently, only `WILDCARD_MATCH` is supported, which uses wildcard patterns to match repository names.  
Type: String  
Valid Values: `WILDCARD_MATCH`   
Required: Yes

## See Also
<a name="API_SigningRepositoryFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/SigningRepositoryFilter) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/SigningRepositoryFilter) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/SigningRepositoryFilter) 

# SigningRule
<a name="API_SigningRule"></a>

A signing rule that specifies a signing profile and optional repository filters. When an image is pushed to a matching repository, a signing job is created using the specified profile.

## Contents
<a name="API_SigningRule_Contents"></a>

 ** signingProfileArn **   <a name="ECR-Type-SigningRule-signingProfileArn"></a>
The ARN of the Amazon Signer signing profile to use for signing images that match this rule. For more information about signing profiles, see [Signing profiles](https://docs.amazonaws.cn/signer/latest/developerguide/signing-profiles.html) in the * Amazon Signer Developer Guide*.  
Type: String  
Length Constraints: Maximum length of 200.  
Pattern: `^arn:aws(-[a-z]+)*:signer:[a-z0-9-]+:[0-9]{12}:\/signing-profiles\/[a-zA-Z0-9_]{2,}$`   
Required: Yes

 ** repositoryFilters **   <a name="ECR-Type-SigningRule-repositoryFilters"></a>
A list of repository filters that determine which repositories have their images signed on push. If no filters are specified, all images pushed to the registry are signed using the rule's signing profile. Maximum of 100 filters per rule.  
Type: Array of [SigningRepositoryFilter](API_SigningRepositoryFilter.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: No

## See Also
<a name="API_SigningRule_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/SigningRule) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/SigningRule) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/SigningRule) 

# SubjectIdentifier
<a name="API_SubjectIdentifier"></a>

An object that identifies an image subject.

## Contents
<a name="API_SubjectIdentifier_Contents"></a>

 ** imageDigest **   <a name="ECR-Type-SubjectIdentifier-imageDigest"></a>
The digest of the image.  
Type: String  
Required: Yes

## See Also
<a name="API_SubjectIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/SubjectIdentifier) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/SubjectIdentifier) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/SubjectIdentifier) 

# Tag
<a name="API_Tag"></a>

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

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="ECR-Type-Tag-Key"></a>
One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values.  
Type: String  
Required: Yes

 ** Value **   <a name="ECR-Type-Tag-Value"></a>
A `value` acts as a descriptor within a tag category (key).  
Type: String  
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/Tag) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/Tag) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/Tag) 

# TransitioningImageTotalCount
<a name="API_TransitioningImageTotalCount"></a>

The total count of images transitioning to a storage class.

## Contents
<a name="API_TransitioningImageTotalCount_Contents"></a>

 ** imageTotalCount **   <a name="ECR-Type-TransitioningImageTotalCount-imageTotalCount"></a>
The total number of images transitioning to the storage class.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** targetStorageClass **   <a name="ECR-Type-TransitioningImageTotalCount-targetStorageClass"></a>
The target storage class.  
Type: String  
Valid Values: `ARCHIVE`   
Required: No

## See Also
<a name="API_TransitioningImageTotalCount_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/TransitioningImageTotalCount) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/TransitioningImageTotalCount) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/TransitioningImageTotalCount) 

# VulnerablePackage
<a name="API_VulnerablePackage"></a>

Information on the vulnerable package identified by a finding.

## Contents
<a name="API_VulnerablePackage_Contents"></a>

 ** arch **   <a name="ECR-Type-VulnerablePackage-arch"></a>
The architecture of the vulnerable package.  
Type: String  
Required: No

 ** epoch **   <a name="ECR-Type-VulnerablePackage-epoch"></a>
The epoch of the vulnerable package.  
Type: Integer  
Required: No

 ** filePath **   <a name="ECR-Type-VulnerablePackage-filePath"></a>
The file path of the vulnerable package.  
Type: String  
Required: No

 ** fixedInVersion **   <a name="ECR-Type-VulnerablePackage-fixedInVersion"></a>
The version of the package that contains the vulnerability fix.  
Type: String  
Required: No

 ** name **   <a name="ECR-Type-VulnerablePackage-name"></a>
The name of the vulnerable package.  
Type: String  
Required: No

 ** packageManager **   <a name="ECR-Type-VulnerablePackage-packageManager"></a>
The package manager of the vulnerable package.  
Type: String  
Required: No

 ** release **   <a name="ECR-Type-VulnerablePackage-release"></a>
The release of the vulnerable package.  
Type: String  
Required: No

 ** sourceLayerHash **   <a name="ECR-Type-VulnerablePackage-sourceLayerHash"></a>
The source layer hash of the vulnerable package.  
Type: String  
Required: No

 ** version **   <a name="ECR-Type-VulnerablePackage-version"></a>
The version of the vulnerable package.  
Type: String  
Required: No

## See Also
<a name="API_VulnerablePackage_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/ecr-2015-09-21/VulnerablePackage) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/ecr-2015-09-21/VulnerablePackage) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/ecr-2015-09-21/VulnerablePackage)