Smaws_Client_ECR.Typestype nonrec vulnerable_package = {fixed_in_version : fixed_in_version option;The version of the package that contains the vulnerability fix.
*)version : version option;The version of the vulnerable package.
*)source_layer_hash : source_layer_hash option;The source layer hash of the vulnerable package.
*)release : release option;The release of the vulnerable package.
*)package_manager : package_manager option;The package manager of the vulnerable package.
*)name : vulnerable_package_name option;The name of the vulnerable package.
*)file_path : file_path option;The file path of the vulnerable package.
*)epoch : epoch option;The epoch of the vulnerable package.
*)arch : arch option;The architecture of the vulnerable package.
*)}Information on the vulnerable package identified by a finding.
type nonrec vulnerable_packages_list = vulnerable_package listThere was an exception validating this request.
type nonrec validate_pull_through_cache_rule_response = {failure : ptc_validate_failure option;The reason the validation failed. For more details about possible causes and how to address them, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
*)is_valid : is_ptc_rule_valid option;Whether or not the pull through cache rule was validated. If true, Amazon ECR was able to reach the upstream registry and authentication was successful. If false, there was an issue and validation failed. The failure reason indicates the cause.
upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The upstream repository prefix associated with the pull through cache rule.
*)custom_role_arn : custom_role_arn option;The ARN of the IAM role associated with the pull through cache rule.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.
*)upstream_registry_url : url option;The upstream registry URL associated with the pull through cache rule.
*)registry_id : registry_id option;The registry ID associated with the request.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix option;The Amazon ECR repository prefix associated with the pull through cache rule.
*)}type nonrec validate_pull_through_cache_rule_request = {registry_id : registry_id option;The registry ID associated with the pull through cache rule. If you do not specify a registry, the default registry is assumed.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix;The repository name prefix associated with the pull through cache rule.
*)}type nonrec server_exception = {message : exception_message option;The error message associated with the exception.
*)}These errors are usually caused by a server-side issue.
The pull through cache rule was not found. Specify a valid pull through cache rule and try again.
type nonrec invalid_parameter_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified parameter is invalid. Review the available parameters for the API request.
type nonrec upload_not_found_exception = {message : exception_message option;The error message associated with the exception.
*)}The upload could not be found, or the specified upload ID is not valid for this repository.
type nonrec part_size = Smaws_Lib.CoreTypes.Int64.ttype nonrec upload_layer_part_response = {last_byte_received : part_size option;The integer value of the last byte received in the request.
*)upload_id : upload_id option;The upload ID associated with the request.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec upload_layer_part_request = {layer_part_blob : layer_part_blob;The base64-encoded layer part payload.
*)part_last_byte : part_size;The position of the last byte of the layer part within the overall image layer.
*)part_first_byte : part_size;The position of the first byte of the layer part witin the overall image layer.
*)upload_id : upload_id;The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
repository_name : repository_name;The name of the repository to which you are uploading layer parts.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.
*)}type nonrec repository_not_found_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
type nonrec limit_exceeded_exception = {message : exception_message option;The error message associated with the exception.
*)}The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.
type nonrec kms_exception = {kms_error : kms_error option;The error code returned by KMS.
*)message : exception_message option;}The operation failed due to a KMS exception.
type nonrec invalid_layer_part_exception = {message : exception_message option;The error message associated with the exception.
*)last_valid_byte_received : part_size option;The last valid byte received from the layer part upload that is associated with the exception.
*)upload_id : upload_id option;The upload ID associated with the exception.
*)repository_name : repository_name option;The repository name associated with the exception.
*)registry_id : registry_id option;The registry ID associated with the exception.
*)}The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.
type nonrec encryption_configuration_for_repository_creation_template = {kms_key : kms_key_for_repository_creation_template option;If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
encryption_type : encryption_type;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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) 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) in the Amazon Simple Storage Service Console Developer Guide.
}The encryption configuration to associate with the repository creation template.
type nonrec tag = {value : tag_value;A value acts as a descriptor within a tag category (key).
key : tag_key;One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
}The 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.
type nonrec tag_list = tag listtype nonrec image_tag_mutability_exclusion_filter = {filter : image_tag_mutability_exclusion_filter_value;The filter value used to match image tags for exclusion from mutability settings.
*)filter_type : image_tag_mutability_exclusion_filter_type;The type of filter to apply for excluding image tags from mutability settings.
*)}A filter that specifies which image tags should be excluded from the repository's image tag mutability setting.
type nonrec image_tag_mutability_exclusion_filters =
image_tag_mutability_exclusion_filter listtype nonrec rct_applied_for_list = rct_applied_for listtype nonrec repository_creation_template = {updated_at : date option;The date and time, in JavaScript date format, when the repository creation template was last updated.
*)created_at : date option;The date and time, in JavaScript date format, when the repository creation template was created.
*)custom_role_arn : custom_role_arn option;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.
*)applied_for : rct_applied_for_list option;A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
*)lifecycle_policy : lifecycle_policy_text_for_repository_creation_template
option;The lifecycle policy to use for repositories created using the template.
*)repository_policy : repository_policy_text option;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.
*)image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags are excluded from the repository creation template's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;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.
encryption_configuration : encryption_configuration_for_repository_creation_template
option;The encryption configuration associated with the repository creation template.
*)description : repository_template_description option;The description associated with the repository creation template.
*)prefix : prefix option;The repository namespace prefix associated with the repository creation template.
*)}The details of the repository creation template associated with the request.
type nonrec update_repository_creation_template_response = {repository_creation_template : repository_creation_template option;The details of the repository creation template associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec update_repository_creation_template_request = {custom_role_arn : custom_role_arn option;The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. 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.
*)applied_for : rct_applied_for_list option;Updates the list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
lifecycle_policy : lifecycle_policy_text_for_repository_creation_template
option;Updates the lifecycle policy associated with the specified repository creation template.
*)repository_policy : repository_policy_text option;Updates the repository policy created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.
*)image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags should be excluded from the repository creation template's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;Updates 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.
encryption_configuration : encryption_configuration_for_repository_creation_template
option;description : repository_template_description option;A description for the repository creation template.
*)prefix : prefix;The repository namespace prefix that matches an existing repository creation template in the registry. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. This includes a repository named prod/team1 as well as a repository named prod/repository1.
To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.
}The specified repository creation template can't be found. Verify the registry ID and prefix and try again.
type nonrec update_pull_through_cache_rule_response = {upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The upstream repository prefix associated with the pull through cache rule.
*)custom_role_arn : custom_role_arn option;The ARN of the IAM role associated with the pull through cache rule.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.
*)updated_at : updated_timestamp option;The date and time, in JavaScript date format, when the pull through cache rule was updated.
*)registry_id : registry_id option;The registry ID associated with the request.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix option;The Amazon ECR repository prefix associated with the pull through cache rule.
*)}type nonrec update_pull_through_cache_rule_request = {custom_role_arn : custom_role_arn option;Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix;The repository name prefix to use when caching images from the source registry.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry associated with the pull through cache rule. If you do not specify a registry, the default registry is assumed.
*)}The secret is accessible but is unable to be decrypted. Verify the resource permisisons and try again.
The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
type nonrec image_identifier = {image_tag : image_tag option;The tag used for the image.
*)image_digest : image_digest option;The sha256 digest of the image manifest.
}An object with identifying information for an image in an Amazon ECR repository.
type nonrec update_image_storage_class_response = {image_status : image_status option;The current status of the image after the call to UpdateImageStorageClass is complete. Valid values are ACTIVE, ARCHIVED, and ACTIVATING.
image_id : image_identifier option;repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec update_image_storage_class_request = {target_storage_class : target_storage_class;The target storage class for the image.
*)image_id : image_identifier;repository_name : repository_name;The name of the repository that contains the image to transition.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the image to transition. If you do not specify a registry, the default registry is assumed.
*)}type nonrec image_storage_class_update_not_supported_exception = {message : exception_message option;}The requested image storage class update is not supported.
The image requested does not exist in the specified repository.
type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;The keys of the tags to be removed.
*)resource_arn : arn;The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
*)}The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
The specified upstream registry isn't supported.
The image is of a type that cannot be scanned.
type nonrec unable_to_list_upstream_image_referrers_exception = {message : exception_message option;}The referrer or referrers were unable to be listed using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream registry.
There was an issue getting the upstream layer matching the pull through cache rule.
The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream registry.
type nonrec transitioning_image_total_count = {image_total_count : image_count option;The total number of images transitioning to the storage class.
*)target_storage_class : lifecycle_policy_target_storage_class option;The target storage class.
*)}The total count of images transitioning to a storage class.
type nonrec transitioning_image_total_counts =
transitioning_image_total_count listThe repository creation template already exists. Specify a unique prefix and try again.
type nonrec tag_resource_request = {resource_arn : arn;The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
*)}An object that identifies an image subject.
type nonrec start_lifecycle_policy_preview_response = {status : lifecycle_policy_preview_status option;The status of the lifecycle policy preview request.
*)lifecycle_policy_text : lifecycle_policy_text option;The JSON repository policy text.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec start_lifecycle_policy_preview_request = {lifecycle_policy_text : lifecycle_policy_text option;The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
*)repository_name : repository_name;The name of the repository to be evaluated.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}The previous lifecycle policy preview request has not completed. Wait and try again.
The lifecycle policy could not be found, and no policy is set to the repository.
type nonrec image_scan_status = {description : scan_status_description option;The description of the image scan status.
*)status : scan_status option;The current state of an image scan.
*)}The current status of an image scan.
type nonrec start_image_scan_response = {image_scan_status : image_scan_status option;The current state of the scan.
*)image_id : image_identifier option;repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec start_image_scan_request = {image_id : image_identifier;repository_name : repository_name;The name of the repository that contains the images to scan.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.
*)}The specified image is archived and cannot be scanned.
The image signing status. Possible values include IN_PROGRESS, COMPLETE, and FAILED.
The type of filter to use when determining which repositories should have their images automatically signed.
type nonrec signing_repository_filter = {filter_type : signing_repository_filter_type;The type of filter to apply. Currently, only WILDCARD_MATCH is supported, which uses wildcard patterns to match repository names.
filter : signing_repository_filter_value;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}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.
type nonrec signing_repository_filter_list = signing_repository_filter listtype nonrec signing_rule = {repository_filters : signing_repository_filter_list option;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.
*)signing_profile_arn : signing_profile_arn;The ARN of the Amazon Web Services Signer signing profile to use for signing images that match this rule. For more information about signing profiles, see Signing profiles in the Amazon Web Services Signer Developer Guide.
*)}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.
type nonrec signing_rule_list = signing_rule listtype nonrec signing_configuration_not_found_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified signing configuration was not found. This occurs when attempting to retrieve or delete a signing configuration that does not exist.
type nonrec signing_configuration = {rules : signing_rule_list;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.
*)}The signing configuration for a registry, which specifies rules for automatically signing images when pushed.
type nonrec set_repository_policy_response = {policy_text : repository_policy_text option;The JSON repository policy text applied to the repository.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec set_repository_policy_request = {force : force_flag option;If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.
policy_text : repository_policy_text;The JSON repository policy text to apply to the repository. For more information, see Amazon ECR repository policies in the Amazon Elastic Container Registry User Guide.
*)repository_name : repository_name;The name of the repository to receive the policy.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec cvss_score_adjustment = {reason : reason option;The reason the CVSS score has been adjustment.
*)metric : metric option;The metric used to adjust the CVSS score.
*)}Details on adjustments Amazon Inspector made to the CVSS score for a finding.
type nonrec cvss_score_adjustment_list = cvss_score_adjustment listtype nonrec cvss_score_details = {version : version option;The CVSS version used in scoring.
*)scoring_vector : scoring_vector option;The vector for the CVSS score.
*)score_source : source option;The source for the CVSS score.
*)score : score option;The CVSS score.
*)adjustments : cvss_score_adjustment_list option;An object that contains details about adjustment Amazon Inspector made to the CVSS score.
*)}Information about the CVSS score.
type nonrec score_details = {cvss : cvss_score_details option;An object that contains details about the CVSS score given to a finding.
*)}Information about the Amazon Inspector score given to a finding.
type nonrec scanning_repository_filter = {filter_type : scanning_repository_filter_type;The type associated with the filter.
*)filter : scanning_repository_filter_value;The filter to use when scanning.
*)}The details of a scanning repository filter. For more information on how to use filters, see Using filters in the Amazon Elastic Container Registry User Guide.
type nonrec scanning_repository_filter_list = scanning_repository_filter listtype nonrec scanning_configuration_repository_name_list = repository_name listThe specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.
type nonrec image_tags_list = image_tag listtype nonrec in_use_count = Smaws_Lib.CoreTypes.Int64.ttype nonrec aws_ecr_container_image_details = {repository_name : repository_name option;The name of the repository the Amazon ECR container image resides in.
*)registry : registry_id option;The registry the Amazon ECR container image belongs to.
*)in_use_count : in_use_count option;The number of Amazon ECS or Amazon EKS clusters currently running the image.
*)last_in_use_at : date option;The most recent date and time a cluster was running the image.
*)pushed_at : date option;The date and time the Amazon ECR container image was pushed.
*)platform : platform option;The platform of the Amazon ECR container image.
*)image_hash : image_digest option;The image hash of the Amazon ECR container image.
*)architecture : arch option;The architecture of the Amazon ECR container image.
*)}The image details of the Amazon ECR container image.
type nonrec resource_details = {aws_ecr_container_image : aws_ecr_container_image_details option;An object that contains details about the Amazon ECR container image involved in the finding.
*)}Contains details about the resource involved in the finding.
type nonrec resource = {type_ : type_ option;The type of resource.
*)id : resource_id option;The ID of the resource.
*)details : resource_details option;An object that contains details about the resource involved in a finding.
*)}Details about the resource involved in a finding.
type nonrec resource_list = resource listtype nonrec repository_scanning_configuration = {applied_scan_filters : scanning_repository_filter_list option;The scan filters applied to the repository.
*)scan_frequency : scan_frequency option;The scan frequency for the repository.
*)scan_on_push : scan_on_push_flag option;Whether or not scan on push is configured for the repository.
*)repository_name : repository_name option;The name of the repository.
*)repository_arn : arn option;The ARN of the repository.
*)}The details of the scanning configuration for a repository.
type nonrec repository_scanning_configuration_list =
repository_scanning_configuration listtype nonrec repository_scanning_configuration_failure = {failure_reason : scanning_configuration_failure_reason option;The reason for the failure.
*)failure_code : scanning_configuration_failure_code option;The failure code.
*)repository_name : repository_name option;The name of the repository.
*)}The details about any failures associated with the scanning configuration of a repository.
type nonrec repository_scanning_configuration_failure_list =
repository_scanning_configuration_failure listtype nonrec repository_policy_not_found_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified repository and registry combination does not have an associated repository policy.
type nonrec repository_not_empty_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.
type nonrec repository_name_list = repository_name listtype nonrec image_scanning_configuration = {scan_on_push : scan_on_push_flag option;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_StartImageScan API.
}The image scanning configuration for a repository.
type nonrec encryption_configuration = {kms_key : kms_key option;If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.
encryption_type : encryption_type;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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created.
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 KMS Management Service key stored in KMS. Similar to the KMS encryption type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own 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 in the Amazon Elastic Container Registry User Guide.
*)}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 Key Management Service key stored in Key Management Service (KMS) to encrypt your images. For more information, see Amazon ECR encryption at rest in the Amazon Elastic Container Registry User Guide.
type nonrec repository = {encryption_configuration : encryption_configuration option;The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
*)image_scanning_configuration : image_scanning_configuration option;image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags are excluded from the repository's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;The tag mutability setting for the repository.
*)created_at : creation_timestamp option;The date and time, in JavaScript date format, when the repository was created.
*)repository_uri : url option;The URI for the repository. You can use this URI for container image push and pull operations.
repository_name : repository_name option;The name of the repository.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository.
*)repository_arn : arn option;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 Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.
}An object representing a repository.
type nonrec repository_list = repository listtype nonrec repository_filter = {filter_type : repository_filter_type;The repository filter type. The only supported value is PREFIX_MATCH, which is a repository name prefix specified with the filter parameter.
filter : repository_filter_value;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.
}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.
type nonrec repository_filter_list = repository_filter listtype nonrec repository_creation_template_list =
repository_creation_template listtype nonrec repository_already_exists_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified repository already exists in the specified registry.
type nonrec replication_destination = {registry_id : registry_id;The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.
*)region : region;The Region to replicate to.
*)}An array of objects representing the destination for a replication rule.
type nonrec replication_destination_list = replication_destination listtype nonrec replication_rule = {repository_filters : repository_filter_list option;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.
*)destinations : replication_destination_list;An array of objects representing the destination for a replication rule.
*)}An array of objects representing the replication destinations and repository filters for a replication configuration.
type nonrec replication_rule_list = replication_rule listtype nonrec replication_configuration = {rules : replication_rule_list;An array of objects representing the replication destinations and repository filters for a replication configuration.
*)}The replication configuration for a registry.
type nonrec recommendation = {text : recommendation_text option;The recommended course of action to remediate the finding.
*)url : url option;The URL address to the CVE remediation recommendations.
*)}Details about the recommended course of action to remediate the finding.
type nonrec remediation = {recommendation : recommendation option;An object that contains information about the recommended course of action to remediate the finding.
*)}Information on how to remediate a finding.
type nonrec registry_scanning_rule = {repository_filters : scanning_repository_filter_list;The repository filters associated with the scanning configuration for a private registry.
*)scan_frequency : scan_frequency;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.
}The details of a scanning rule for a private registry.
type nonrec registry_scanning_rule_list = registry_scanning_rule listtype nonrec registry_scanning_configuration = {rules : registry_scanning_rule_list option;The scanning rules associated with the registry.
*)scan_type : scan_type option;The type of scanning configured for the registry.
*)}The scanning configuration for a private registry.
The registry doesn't have an associated registry policy.
type nonrec register_pull_time_update_exclusion_response = {created_at : creation_timestamp option;The date and time, expressed in standard JavaScript date format, when the exclusion was created.
*)principal_arn : principal_arn option;The ARN of the IAM principal that was added to the pull time update exclusion list.
*)}type nonrec register_pull_time_update_exclusion_request = {principal_arn : principal_arn;The ARN of the IAM principal to exclude from having image pull times recorded.
*)}The specified pull time update exclusion already exists for the registry.
The manifest list is referencing an image that does not exist.
type nonrec reference_urls_list = url listtype nonrec put_signing_configuration_response = {signing_configuration : signing_configuration option;The registry's updated signing configuration.
*)}type nonrec put_signing_configuration_request = {signing_configuration : signing_configuration;The signing configuration to assign to the registry.
*)}type nonrec put_replication_configuration_response = {replication_configuration : replication_configuration option;The contents of the replication configuration for the registry.
*)}type nonrec put_replication_configuration_request = {replication_configuration : replication_configuration;An object representing the replication configuration for a registry.
*)}type nonrec put_registry_scanning_configuration_response = {registry_scanning_configuration : registry_scanning_configuration option;The scanning configuration for your registry.
*)}type nonrec put_registry_scanning_configuration_request = {rules : registry_scanning_rule_list option;The scanning rules to use for the registry. A scanning rule is used to determine which repository filters are used and at what frequency scanning will occur.
*)scan_type : scan_type option;The scanning type to set for the registry.
When a registry scanning configuration is not defined, by default the BASIC scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.
When the ENHANCED scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.
}The operation did not succeed because the account is managed by a organization policy.
type nonrec put_registry_policy_response = {policy_text : registry_policy_text option;The JSON policy text for your registry.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec put_registry_policy_request = {policy_text : registry_policy_text;The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
*)}type nonrec put_lifecycle_policy_response = {lifecycle_policy_text : lifecycle_policy_text option;The JSON repository policy text.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec put_lifecycle_policy_request = {lifecycle_policy_text : lifecycle_policy_text;The JSON repository policy text to apply to the repository.
*)repository_name : repository_name;The name of the repository to receive the policy.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec put_image_tag_mutability_response = {image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;The list of filters that specify which image tags are excluded from the repository's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;The image tag mutability setting for the repository.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec put_image_tag_mutability_request = {image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags should be excluded from the image tag mutability setting being applied.
*)image_tag_mutability : image_tag_mutability;The tag mutability setting for the repository. If MUTABLE is specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
repository_name : repository_name;The name of the repository in which to update the image tag mutability settings.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.
*)}type nonrec put_image_scanning_configuration_response = {image_scanning_configuration : image_scanning_configuration option;The image scanning configuration setting for the repository.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec put_image_scanning_configuration_request = {image_scanning_configuration : image_scanning_configuration;The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
*)repository_name : repository_name;The name of the repository in which to update the image scanning configuration setting.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.
*)}type nonrec image = {image_manifest_media_type : media_type option;The manifest media type of the image.
*)image_manifest : image_manifest option;The image manifest associated with the image.
*)image_id : image_identifier option;An object containing the image tag and image digest associated with an image.
*)repository_name : repository_name option;The name of the repository associated with the image.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry containing the image.
*)}An object representing an Amazon ECR image.
type nonrec put_image_request = {image_digest : image_digest option;The image digest of the image manifest corresponding to the image.
*)image_tag : image_tag option;The tag to associate with the image. This parameter is optional.
*)image_manifest_media_type : media_type option;The media type of the image manifest. If you push an image manifest that does not contain the mediaType field, you must specify the imageManifestMediaType in the request.
image_manifest : image_manifest;The image manifest corresponding to the image to be uploaded.
*)repository_name : repository_name;The name of the repository in which to put the image.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.
*)}type nonrec layers_not_found_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified layers could not be found, or the specified layer is not valid for this repository.
The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
The specified image digest does not match the digest that Amazon ECR calculated for the image.
type nonrec image_already_exists_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
type nonrec put_account_setting_response = {value : account_setting_value option;Retrieves the value of the specified account setting.
*)name : account_setting_name option;Retrieves the name of the account setting.
*)}type nonrec put_account_setting_request = {value : account_setting_value;Setting value that is specified. Valid value for basic scan type: AWS_NATIVE. Valid values for registry policy scope: V2. Valid values for blob mounting: ENABLED or DISABLED.
name : account_setting_name;The name of the account setting, such as BASIC_SCAN_TYPE_VERSION, REGISTRY_POLICY_SCOPE, or BLOB_MOUNTING.
}type nonrec pull_time_update_exclusion_list = principal_arn listtype nonrec pull_through_cache_rule_repository_prefix_list =
pull_through_cache_rule_repository_prefix listtype nonrec pull_through_cache_rule = {updated_at : updated_timestamp option;The date and time, in JavaScript date format, when the pull through cache rule was last updated.
*)upstream_registry : upstream_registry option;The name of the upstream source registry associated with the pull through cache rule.
*)upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The upstream repository prefix associated with the pull through cache rule.
*)custom_role_arn : custom_role_arn option;The ARN of the IAM role associated with the pull through cache rule.
*)credential_arn : credential_arn option;The ARN of the Secrets Manager secret associated with the pull through cache rule.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry the pull through cache rule is associated with.
*)created_at : creation_timestamp option;The date and time the pull through cache was created.
*)upstream_registry_url : url option;The upstream registry URL associated with the pull through cache rule.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix option;The Amazon ECR repository prefix associated with the pull through cache rule.
*)}The details of a pull through cache rule.
type nonrec pull_through_cache_rule_list = pull_through_cache_rule listtype nonrec pull_through_cache_rule_already_exists_exception = {message : exception_message option;}A pull through cache rule with these settings already exists for the private registry.
type nonrec prefix_list = prefix listtype nonrec cvss_score = {version : version option;The version of CVSS used for the score.
*)source : source option;The source of the CVSS score.
*)scoring_vector : scoring_vector option;The vector string of the CVSS score.
*)base_score : base_score option;The base CVSS score used for the finding.
*)}The CVSS score for a finding.
type nonrec cvss_score_list = cvss_score listtype nonrec package_vulnerability_details = {vulnerable_packages : vulnerable_packages_list option;The packages impacted by this vulnerability.
*)vulnerability_id : vulnerability_id option;The ID given to this vulnerability.
*)vendor_updated_at : date option;The date and time the vendor last updated this vulnerability in their database.
*)vendor_severity : severity option;The severity the vendor has given to this vulnerability type.
*)vendor_created_at : date option;The date and time that this vulnerability was first added to the vendor's database.
*)source_url : url option;A URL to the source of the vulnerability information.
*)source : source option;The source of the vulnerability information.
*)reference_urls : reference_urls_list option;One or more URLs that contain details about this vulnerability type.
*)cvss : cvss_score_list option;An object that contains details about the CVSS score of a finding.
*)}Information about a package vulnerability finding.
type nonrec media_type_list = media_type listtype nonrec list_pull_time_update_exclusions_response = {next_token : next_token option;The nextToken value to include in a future ListPullTimeUpdateExclusions request. When the results of a ListPullTimeUpdateExclusions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
pull_time_update_exclusions : pull_time_update_exclusion_list option;The list of IAM principal ARNs that are excluded from having their image pull times recorded.
*)}type nonrec list_pull_time_update_exclusions_request = {next_token : next_token option;The nextToken value returned from a previous paginated ListPullTimeUpdateExclusions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*)max_results : max_results option;The maximum number of pull time update exclusion results returned by ListPullTimeUpdateExclusions in paginated output. When this parameter is used, ListPullTimeUpdateExclusions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListPullTimeUpdateExclusions request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListPullTimeUpdateExclusions returns up to 100 results and a nextToken value, if applicable.
}type nonrec image_identifier_list = image_identifier listtype nonrec list_images_response = {next_token : next_token option;The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
image_ids : image_identifier_list option;The list of image IDs for the requested repository.
*)}type nonrec list_images_filter = {image_status : image_status_filter option;The image status with which to filter your ListImages results. Valid values are ACTIVE, ARCHIVED, and ACTIVATING. If not specified, only images with ACTIVE status are returned.
tag_status : tag_status option;The tag status with which to filter your ListImages results.
}An object representing a filter on a ListImages operation.
type nonrec list_images_request = {filter : list_images_filter option;The filter key and value with which to filter your ListImages results.
max_results : max_results option;The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.
next_token : next_token option;The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*)repository_name : repository_name;The repository with image IDs to be listed.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.
*)}type nonrec image_size_in_bytes = Smaws_Lib.CoreTypes.Int64.ttype nonrec image_referrer = {artifact_status : artifact_status option;The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.
annotations : annotations option;A map of annotations associated with the artifact.
*)size : image_size_in_bytes;The size, in bytes, of the artifact.
*)artifact_type : artifact_type option;A string identifying the type of artifact.
*)media_type : media_type;The media type of the artifact manifest.
*)digest : image_digest;The digest of the artifact manifest.
*)}An object representing an artifact associated with a subject image.
type nonrec image_referrer_list = image_referrer listtype nonrec list_image_referrers_response = {next_token : next_token option;The nextToken value to include in a future ListImageReferrers request. When the results of a ListImageReferrers request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
referrers : image_referrer_list option;The list of artifacts associated with the subject image.
*)}type nonrec artifact_type_list = artifact_type listtype nonrec list_image_referrers_filter = {artifact_status : artifact_status_filter option;The artifact status with which to filter your ListImageReferrers results. Valid values are ACTIVE, ARCHIVED, ACTIVATING, or ANY. If not specified, only artifacts with ACTIVE status are returned.
artifact_types : artifact_type_list option;The artifact types with which to filter your ListImageReferrers results.
}An object representing a filter on a ListImageReferrers operation.
type nonrec list_image_referrers_request = {max_results : fifty_max_results option;The maximum number of image referrer results returned by ListImageReferrers in paginated output. When this parameter is used, ListImageReferrers only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImageReferrers request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then ListImageReferrers returns up to 20 results and a nextToken value, if applicable.
next_token : next_token option;The nextToken value returned from a previous paginated ListImageReferrers request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*)filter : list_image_referrers_filter option;The filter key and value with which to filter your ListImageReferrers results. If no filter is specified, only artifacts with ACTIVE status are returned.
subject_id : subject_identifier;An object containing the image digest of the subject image for which to retrieve associated artifacts.
*)repository_name : repository_name;The name of the repository that contains the subject image.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to list image referrers. If you do not specify a registry, the default registry is assumed.
*)}type nonrec lifecycle_policy_rule_action = {target_storage_class : lifecycle_policy_target_storage_class option;The target storage class for the action. This is only present when the type is TRANSITION.
type_ : image_action_type option;The type of action to be taken.
*)}The type of action to be taken.
type nonrec lifecycle_policy_preview_summary = {transitioning_image_total_counts : transitioning_image_total_counts option;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.
*)expiring_image_total_count : image_count option;The number of expiring images.
*)}The summary of the lifecycle policy preview request.
type nonrec image_tag_list = image_tag listtype nonrec lifecycle_policy_preview_result = {storage_class : lifecycle_policy_storage_class option;The storage class of the image.
*)applied_rule_priority : lifecycle_policy_rule_priority option;The priority of the applied rule.
*)action : lifecycle_policy_rule_action option;The type of action to be taken.
*)image_pushed_at : push_timestamp option;The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
*)image_digest : image_digest option;The sha256 digest of the image manifest.
}The result of the lifecycle policy preview.
type nonrec lifecycle_policy_preview_result_list =
lifecycle_policy_preview_result listThere is no dry run for this repository.
type nonrec lifecycle_policy_preview_filter = {tag_status : tag_status option;The tag status of the image.
*)}The filter for the lifecycle policy preview.
type nonrec layer_size_in_bytes = Smaws_Lib.CoreTypes.Int64.ttype nonrec layer_part_too_small_exception = {message : exception_message option;The error message associated with the exception.
*)}Layer parts must be at least 5 MiB in size.
type nonrec layer = {media_type : media_type option;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.
layer_size : layer_size_in_bytes option;The size, in bytes, of the image layer.
*)layer_availability : layer_availability option;The availability status of the image layer.
*)layer_digest : layer_digest option;The sha256 digest of the image layer.
}An object representing an Amazon ECR image layer.
type nonrec layer_list = layer listtype nonrec layer_inaccessible_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.
type nonrec layer_failure = {failure_reason : layer_failure_reason option;The reason for the failure.
*)failure_code : layer_failure_code option;The failure code associated with the failure.
*)layer_digest : batched_operation_layer_digest option;The layer digest associated with the failure.
*)}An object representing an Amazon ECR image layer failure.
type nonrec layer_failure_list = layer_failure listtype nonrec layer_digest_list = layer_digest listtype nonrec layer_already_exists_exception = {message : exception_message option;The error message associated with the exception.
*)}The image layer already exists in the associated repository.
type nonrec invalid_layer_exception = {message : exception_message option;The error message associated with the exception.
*)}The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
type nonrec initiate_layer_upload_response = {part_size : part_size option;The size, in bytes, that Amazon ECR expects future layer part uploads to be.
*)upload_id : upload_id option;The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
}type nonrec initiate_layer_upload_request = {repository_name : repository_name;The name of the repository to which you intend to upload layers.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.
*)}type nonrec image_signing_status = {status : signing_status option;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.failure_reason : signing_status_failure_reason option;A description of why signing the image failed. This field is only present if status is FAILED.
failure_code : signing_status_failure_code option;The failure code, which is only present if status is FAILED.
signing_profile_arn : signing_profile_arn option;The ARN of the Amazon Web Services Signer signing profile used to sign the image.
*)}The signing status for an image. Each status corresponds to a signing profile.
type nonrec image_signing_status_list = image_signing_status listtype nonrec finding_severity_counts = (finding_severity * severity_count) listtype nonrec image_scan_findings_summary = {finding_severity_counts : finding_severity_counts option;The image vulnerability counts, sorted by severity.
*)vulnerability_source_updated_at : vulnerability_source_update_timestamp option;The time when the vulnerability data was last scanned.
*)image_scan_completed_at : scan_timestamp option;The time of the last completed image scan.
*)}A summary of the last completed image scan.
type nonrec attribute = {value : attribute_value option;The value assigned to the attribute key.
*)key : attribute_key;The attribute key.
*)}This data type is used in the ImageScanFinding data type.
type nonrec attribute_list = attribute listtype nonrec image_scan_finding = {attributes : attribute_list option;A collection of attributes of the host from which the finding is generated.
*)severity : finding_severity option;The finding severity.
*)uri : url option;A link containing additional details about the security vulnerability.
*)description : finding_description option;The description of the finding.
*)name : finding_name option;The name associated with the finding, usually a CVE number.
*)}Contains information about an image scan finding.
type nonrec image_scan_finding_list = image_scan_finding listtype nonrec enhanced_image_scan_finding = {exploit_available : exploit_available option;If a finding discovered in your environment has an exploit available.
*)fix_available : fix_available option;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.
updated_at : date option;The date and time the finding was last updated at.
*)type_ : type_ option;The type of the finding.
*)title : title option;The title of the finding.
*)status : status option;The status of the finding.
*)severity : severity option;The severity of the finding.
*)score_details : score_details option;An object that contains details of the Amazon Inspector score.
*)score : score option;The Amazon Inspector score given to the finding.
*)resources : resource_list option;Contains information on the resources involved in a finding.
*)remediation : remediation option;An object that contains the details about how to remediate a finding.
*)package_vulnerability_details : package_vulnerability_details option;An object that contains the details of a package vulnerability finding.
*)last_observed_at : date option;The date and time that the finding was last observed.
*)first_observed_at : date option;The date and time that the finding was first observed.
*)finding_arn : finding_arn option;The Amazon Resource Number (ARN) of the finding.
*)description : finding_description option;The description of the finding.
*)aws_account_id : registry_id option;The Amazon Web Services account ID associated with the image.
*)}The details of an enhanced image scan. This is returned when enhanced scanning is enabled for your private registry.
type nonrec enhanced_image_scan_finding_list = enhanced_image_scan_finding listtype nonrec image_scan_findings = {enhanced_findings : enhanced_image_scan_finding_list option;Details about the enhanced scan findings from Amazon Inspector.
*)findings : image_scan_finding_list option;The findings from the image scan.
*)finding_severity_counts : finding_severity_counts option;The image vulnerability counts, sorted by severity.
*)vulnerability_source_updated_at : vulnerability_source_update_timestamp option;The time when the vulnerability data was last scanned.
*)image_scan_completed_at : scan_timestamp option;The time of the last completed image scan.
*)}The details of an image scan.
type nonrec image_replication_status = {failure_code : replication_error option;The failure code for a replication that has failed.
*)status : replication_status option;The image replication status.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to which the image belongs.
*)region : region option;The destination Region for the image replication.
*)}The status of the replication process for an image.
type nonrec image_replication_status_list = image_replication_status listtype nonrec image_list = image listtype nonrec image_failure = {failure_reason : image_failure_reason option;The reason for the failure.
*)failure_code : image_failure_code option;The code associated with the failure.
*)image_id : image_identifier option;The image ID associated with the failure.
*)}An object representing an Amazon ECR image failure.
type nonrec image_failure_list = image_failure listtype nonrec image_detail = {last_activated_at : last_activated_at_timestamp option;The date and time, expressed in standard JavaScript date format, when the image was last restored from Amazon ECR archive to Amazon ECR standard.
*)last_archived_at : last_archived_at_timestamp option;The date and time, expressed in standard JavaScript date format, when the image was last transitioned to Amazon ECR archive.
*)image_status : image_status option;The current status of the image.
*)subject_manifest_digest : image_digest option;The digest of the subject manifest for images that are referrers.
*)last_recorded_pull_time : recorded_pull_timestamp option;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.
artifact_media_type : media_type option;The artifact media type of the image.
*)image_manifest_media_type : media_type option;The media type of the image manifest.
*)image_scan_findings_summary : image_scan_findings_summary option;A summary of the last completed image scan.
*)image_scan_status : image_scan_status option;The current state of the scan.
*)image_pushed_at : push_timestamp option;The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
*)image_size_in_bytes : image_size_in_bytes option;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.
image_digest : image_digest option;The sha256 digest of the image manifest.
repository_name : repository_name option;The name of the repository to which this image belongs.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to which this image belongs.
*)}An object that describes an image returned by a DescribeImages operation.
type nonrec image_detail_list = image_detail listtype nonrec get_signing_configuration_response = {signing_configuration : signing_configuration option;The registry's signing configuration.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry.
*)}type nonrec get_repository_policy_response = {policy_text : repository_policy_text option;The JSON repository policy text associated with the repository.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec get_repository_policy_request = {repository_name : repository_name;The name of the repository with the policy to retrieve.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec get_registry_scanning_configuration_response = {scanning_configuration : registry_scanning_configuration option;The scanning configuration for the registry.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec get_registry_policy_response = {policy_text : registry_policy_text option;The JSON text of the permissions policy for a registry.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec get_lifecycle_policy_response = {last_evaluated_at : evaluation_timestamp option;The time stamp of the last time that the lifecycle policy was run.
*)lifecycle_policy_text : lifecycle_policy_text option;The JSON lifecycle policy text.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec get_lifecycle_policy_request = {repository_name : repository_name;The name of the repository.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec get_lifecycle_policy_preview_response = {summary : lifecycle_policy_preview_summary option;The list of images that is returned as a result of the action.
*)preview_results : lifecycle_policy_preview_result_list option;The results of the lifecycle policy preview request.
*)next_token : next_token option;The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
status : lifecycle_policy_preview_status option;The status of the lifecycle policy preview request.
*)lifecycle_policy_text : lifecycle_policy_text option;The JSON lifecycle policy text.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec get_lifecycle_policy_preview_request = {filter : lifecycle_policy_preview_filter option;An optional parameter that filters results based on image tag status and all tags, if tagged.
*)max_results : lifecycle_preview_max_results option;The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
maxResults results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending
another GetLifecyclePolicyPreviewRequest request with the returned nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
100 results and a nextToken value, if
applicable. This option cannot be used when you specify images with imageIds.
next_token : next_token option;The nextToken value returned from a previous paginated
GetLifecyclePolicyPreviewRequest request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from the end of the
previous results that returned the nextToken value. This value is
null when there are no more results to return. This option cannot be used when you specify images with imageIds.
image_ids : image_identifier_list option;The list of imageIDs to be included.
*)repository_name : repository_name;The name of the repository.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec get_download_url_for_layer_response = {layer_digest : layer_digest option;The digest of the image layer to download.
*)download_url : url option;The pre-signed Amazon S3 download URL for the requested layer.
*)}type nonrec get_download_url_for_layer_request = {layer_digest : layer_digest;The digest of the image layer to download.
*)repository_name : repository_name;The name of the repository that is associated with the image layer to download.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
*)}An object representing authorization data for an Amazon ECR registry.
type nonrec authorization_data_list = authorization_data listtype nonrec get_authorization_token_registry_id_list = registry_id listtype nonrec get_account_setting_response = {value : account_setting_name option;The setting value for the setting name. Valid value for basic scan type: AWS_NATIVE. Valid values for registry policy scope: V2. Valid values for blob mounting: ENABLED or DISABLED.
name : account_setting_name option;Retrieves the name of the account setting.
*)}type nonrec get_account_setting_request = {name : account_setting_name;The name of the account setting, such as BASIC_SCAN_TYPE_VERSION, REGISTRY_POLICY_SCOPE, or BLOB_MOUNTING.
}The specified pull time update exclusion was not found.
type nonrec empty_upload_exception = {message : exception_message option;The error message associated with the exception.
*)}The specified layer upload does not contain any layer parts.
type nonrec describe_repository_creation_templates_response = {next_token : next_token option;The nextToken value to include in a future DescribeRepositoryCreationTemplates request. When the results of a DescribeRepositoryCreationTemplates request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
repository_creation_templates : repository_creation_template_list option;The details of the repository creation templates.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec describe_repository_creation_templates_request = {max_results : max_results option;The maximum number of repository results returned by DescribeRepositoryCreationTemplatesRequest in paginated output. When this parameter is used, DescribeRepositoryCreationTemplatesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositoryCreationTemplatesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositoryCreationTemplatesRequest returns up to 100 results and a nextToken value, if applicable.
next_token : next_token option;The nextToken value returned from a previous paginated DescribeRepositoryCreationTemplates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*)prefixes : prefix_list option;The repository namespace prefixes associated with the repository creation templates to describe. If this value is not specified, all repository creation templates are returned.
*)}type nonrec describe_repositories_response = {next_token : next_token option;The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
repositories : repository_list option;A list of repository objects corresponding to valid repositories.
*)}type nonrec describe_repositories_request = {max_results : max_results option;The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.
next_token : next_token option;The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
*)repository_names : repository_name_list option;A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.
*)}type nonrec describe_registry_response = {replication_configuration : replication_configuration option;The replication configuration for the registry.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec describe_pull_through_cache_rules_response = {next_token : next_token option;The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
pull_through_cache_rules : pull_through_cache_rule_list option;The details of the pull through cache rules.
*)}type nonrec describe_pull_through_cache_rules_request = {max_results : max_results option;The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.
next_token : next_token option;The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
ecr_repository_prefixes : pull_through_cache_rule_repository_prefix_list option;The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.
*)}type nonrec describe_images_response = {next_token : next_token option;The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
image_details : image_detail_list option;A list of ImageDetail objects that contain data about the image.
}type nonrec describe_images_filter = {image_status : image_status_filter option;The image status with which to filter your DescribeImages results. Valid values are ACTIVE, ARCHIVED, and ACTIVATING. If not specified, only images with ACTIVE status are returned.
tag_status : tag_status option;The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.
}An object representing a filter on a DescribeImages operation.
type nonrec describe_images_request = {filter : describe_images_filter option;The filter key and value with which to filter your DescribeImages results.
max_results : max_results option;The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.
next_token : next_token option;The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.
image_ids : image_identifier_list option;The list of image IDs for the requested repository.
*)repository_name : repository_name;The repository that contains the images to describe.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
*)}type nonrec describe_image_signing_status_response = {signing_statuses : image_signing_status_list option;A list of signing statuses for the specified image. Each status corresponds to a signing profile.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry.
*)image_id : image_identifier option;An object with identifying information for the image.
*)repository_name : repository_name option;The name of the repository.
*)}type nonrec describe_image_signing_status_request = {registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)image_id : image_identifier;An object containing identifying information for an image.
*)repository_name : repository_name;The name of the repository that contains the image.
*)}type nonrec describe_image_scan_findings_response = {next_token : next_token option;The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
image_scan_findings : image_scan_findings option;The information contained in the image scan findings.
*)image_scan_status : image_scan_status option;The current state of the scan.
*)image_id : image_identifier option;repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec describe_image_scan_findings_request = {max_results : max_results option;The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.
next_token : next_token option;The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.
image_id : image_identifier;repository_name : repository_name;The repository for the image for which to describe the scan findings.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.
*)}type nonrec describe_image_replication_status_response = {replication_statuses : image_replication_status_list option;The replication status details for the images in the specified repository.
*)image_id : image_identifier option;repository_name : repository_name option;The repository name associated with the request.
*)}type nonrec describe_image_replication_status_request = {registry_id : registry_id option;The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.
*)image_id : image_identifier;repository_name : repository_name;The name of the repository that the image is in.
*)}type nonrec deregister_pull_time_update_exclusion_response = {principal_arn : principal_arn option;The ARN of the IAM principal that was removed from the pull time update exclusion list.
*)}type nonrec deregister_pull_time_update_exclusion_request = {principal_arn : principal_arn;The ARN of the IAM principal to remove from the pull time update exclusion list.
*)}type nonrec delete_signing_configuration_response = {signing_configuration : signing_configuration option;The registry's deleted signing configuration.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry.
*)}type nonrec delete_repository_response = {repository : repository option;The repository that was deleted.
*)}type nonrec delete_repository_request = {force : force_flag option;If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.
*)repository_name : repository_name;The name of the repository to delete.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
*)}type nonrec delete_repository_policy_response = {policy_text : repository_policy_text option;The JSON repository policy that was deleted from the repository.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec delete_repository_policy_request = {repository_name : repository_name;The name of the repository that is associated with the repository policy to delete.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.
*)}type nonrec delete_repository_creation_template_response = {repository_creation_template : repository_creation_template option;The details of the repository creation template that was deleted.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec delete_repository_creation_template_request = {prefix : prefix;The repository namespace prefix associated with the repository creation template.
*)}type nonrec delete_registry_policy_response = {policy_text : registry_policy_text option;The contents of the registry permissions policy that was deleted.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec delete_pull_through_cache_rule_response = {upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The upstream repository prefix associated with the pull through cache rule.
*)custom_role_arn : custom_role_arn option;The ARN of the IAM role associated with the pull through cache rule.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.
*)registry_id : registry_id option;The registry ID associated with the request.
*)created_at : creation_timestamp option;The timestamp associated with the pull through cache rule.
*)upstream_registry_url : url option;The upstream registry URL associated with the pull through cache rule.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix option;The Amazon ECR repository prefix associated with the request.
*)}type nonrec delete_pull_through_cache_rule_request = {registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix;The Amazon ECR repository prefix associated with the pull through cache rule to delete.
*)}type nonrec delete_lifecycle_policy_response = {last_evaluated_at : evaluation_timestamp option;The time stamp of the last time that the lifecycle policy was run.
*)lifecycle_policy_text : lifecycle_policy_text option;The JSON lifecycle policy text.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec delete_lifecycle_policy_request = {repository_name : repository_name;The name of the repository.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec create_repository_response = {repository : repository option;The repository that was created.
*)}type nonrec create_repository_request = {encryption_configuration : encryption_configuration option;The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
*)image_scanning_configuration : image_scanning_configuration option;The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
*)image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags should be excluded from the repository's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;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.
repository_name : repository_name;The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).
The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.
*)}type nonrec create_repository_creation_template_response = {repository_creation_template : repository_creation_template option;The details of the repository creation template associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec create_repository_creation_template_request = {custom_role_arn : custom_role_arn option;The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. 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.
*)applied_for : rct_applied_for_list;A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The supported scenarios are PULL_THROUGH_CACHE, REPLICATION, and CREATE_ON_PUSH
lifecycle_policy : lifecycle_policy_text_for_repository_creation_template
option;The lifecycle policy to use for repositories created using the template.
*)repository_policy : repository_policy_text option;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.
*)image_tag_mutability_exclusion_filters : image_tag_mutability_exclusion_filters
option;A list of filters that specify which image tags should be excluded from the repository creation template's image tag mutability setting.
*)image_tag_mutability : image_tag_mutability option;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.
encryption_configuration : encryption_configuration_for_repository_creation_template
option;The encryption configuration to use for repositories created using the template.
*)description : repository_template_description option;A description for the repository creation template.
*)prefix : prefix;The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. Similarly, a prefix of prod/team would apply to all repositories beginning with prod/team/.
To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.
There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/. When using a pull through cache rule, the repository prefix you specify during rule creation is what you should specify as your repository creation template prefix as well.
}type nonrec create_pull_through_cache_rule_response = {upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The upstream repository prefix associated with the pull through cache rule.
*)custom_role_arn : custom_role_arn option;The ARN of the IAM role associated with the pull through cache rule.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.
*)upstream_registry : upstream_registry option;The name of the upstream registry associated with the pull through cache rule.
*)registry_id : registry_id option;The registry ID associated with the request.
*)created_at : creation_timestamp option;The date and time, in JavaScript date format, when the pull through cache rule was created.
*)upstream_registry_url : url option;The upstream registry URL associated with the pull through cache rule.
*)ecr_repository_prefix : pull_through_cache_rule_repository_prefix option;The Amazon ECR repository prefix associated with the pull through cache rule.
*)}type nonrec create_pull_through_cache_rule_request = {upstream_repository_prefix : pull_through_cache_rule_repository_prefix option;The repository name prefix of the upstream registry to match with the upstream repository name. When this field isn't specified, Amazon ECR will use the ROOT.
custom_role_arn : custom_role_arn option;Amazon Resource Name (ARN) of the IAM role to be assumed by Amazon ECR to authenticate to the ECR upstream registry. This role must be in the same account as the registry that you are configuring.
*)credential_arn : credential_arn option;The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.
*)upstream_registry : upstream_registry option;The name of the upstream registry.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.
*)upstream_registry_url : url;The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.
Amazon ECR (ecr) –
.dkr.ecr..amazonaws.comecr-public) – public.ecr.awsdocker-hub) – registry-1.docker.iogithub-container-registry) – ghcr.iogitlab-container-registry) – registry.gitlab.comk8s) – registry.k8s.ioMicrosoft Azure Container Registry (azure-container-registry) –
.azurecr.ioquay) – quay.ioecr_repository_prefix : pull_through_cache_rule_repository_prefix;The repository name prefix to use when caching images from the source registry.
There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/.
}type nonrec complete_layer_upload_response = {layer_digest : layer_digest option;The sha256 digest of the image layer.
upload_id : upload_id option;The upload ID associated with the layer.
*)repository_name : repository_name option;The repository name associated with the request.
*)registry_id : registry_id option;The registry ID associated with the request.
*)}type nonrec complete_layer_upload_request = {layer_digests : layer_digest_list;The sha256 digest of the image layer.
upload_id : upload_id;The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
repository_name : repository_name;The name of the repository to associate with the image layer.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.
*)}type nonrec batched_operation_layer_digest_list =
batched_operation_layer_digest listtype nonrec batch_get_repository_scanning_configuration_response = {failures : repository_scanning_configuration_failure_list option;Any failures associated with the call.
*)scanning_configurations : repository_scanning_configuration_list option;The scanning configuration for the requested repositories.
*)}type nonrec batch_get_repository_scanning_configuration_request = {repository_names : scanning_configuration_repository_name_list;One or more repository names to get the scanning configuration for.
*)}type nonrec batch_get_image_response = {failures : image_failure_list option;Any failures associated with the call.
*)images : image_list option;A list of image objects corresponding to the image references in the request.
*)}type nonrec batch_get_image_request = {accepted_media_types : media_type_list option;The accepted media types for the request.
Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json
image_ids : image_identifier_list;A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
repository_name : repository_name;The repository that contains the images to describe.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
*)}type nonrec batch_delete_image_response = {failures : image_failure_list option;Any failures associated with the call.
*)image_ids : image_identifier_list option;The image IDs of the deleted images.
*)}type nonrec batch_delete_image_request = {image_ids : image_identifier_list;A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.
repository_name : repository_name;The repository that contains the image to delete.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
*)}Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.
type nonrec batch_check_layer_availability_response = {failures : layer_failure_list option;Any failures associated with the call.
*)layers : layer_list option;A list of image layer objects corresponding to the image layer references in the request.
*)}type nonrec batch_check_layer_availability_request = {layer_digests : batched_operation_layer_digest_list;The digests of the image layers to check.
*)repository_name : repository_name;The name of the repository that is associated with the image layers to check.
*)registry_id : registry_id option;The Amazon Web Services account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.
*)}