Module Smaws_Client_ECRPUBLIC.Types

type nonrec usage_text = string
type nonrec url = string
type nonrec exception_message = string
type nonrec upload_not_found_exception = {
  1. message : exception_message option;
}

The upload can't be found, or the specified upload ID isn't valid for this repository.

type nonrec registry_id = string
type nonrec repository_name = string
type nonrec upload_id = string
type nonrec part_size = Smaws_Lib.CoreTypes.Int64.t
type nonrec upload_layer_part_response = {
  1. last_byte_received : part_size option;
    (*

    The integer value of the last byte that's received in the request.

    *)
  2. upload_id : upload_id option;
    (*

    The upload ID that's associated with the request.

    *)
  3. repository_name : repository_name option;
    (*

    The repository name that's associated with the request.

    *)
  4. registry_id : registry_id option;
    (*

    The registry ID that's associated with the request.

    *)
}
type nonrec registry_id_or_alias = string
type nonrec layer_part_blob = bytes
type nonrec upload_layer_part_request = {
  1. layer_part_blob : layer_part_blob;
    (*

    The base64-encoded layer part payload.

    *)
  2. part_last_byte : part_size;
    (*

    The position of the last byte of the layer part within the overall image layer.

    *)
  3. part_first_byte : part_size;
    (*

    The position of the first byte of the layer part witin the overall image layer.

    *)
  4. upload_id : upload_id;
    (*

    The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

    *)
  5. repository_name : repository_name;
    (*

    The name of the repository that you're uploading layer parts to.

    *)
  6. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, that's associated with the registry that you're uploading layer parts to. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec unsupported_command_exception = {
  1. message : exception_message option;
}

The action isn't supported in this Region.

type nonrec server_exception = {
  1. message : exception_message option;
}

These errors are usually caused by a server-side issue.

type nonrec repository_not_found_exception = {
  1. message : exception_message option;
}

The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.

type nonrec registry_not_found_exception = {
  1. message : exception_message option;
}

The registry doesn't exist.

type nonrec limit_exceeded_exception = {
  1. message : exception_message option;
}

The operation didn't 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 invalid_parameter_exception = {
  1. message : exception_message option;
}

The specified parameter is invalid. Review the available parameters for the API request.

type nonrec invalid_layer_part_exception = {
  1. message : exception_message option;
  2. last_valid_byte_received : part_size option;
    (*

    The position of the last byte of the layer part.

    *)
  3. upload_id : upload_id option;
    (*

    The upload ID that's associated with the layer part.

    *)
  4. repository_name : repository_name option;
    (*

    The name of the repository.

    *)
  5. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the layer part.

    *)
}

The layer part size isn't valid, or the first byte specified isn't consecutive to the last byte of a previous layer part upload.

type nonrec untag_resource_response = unit
type nonrec arn = string
type nonrec tag_key = string
type nonrec tag_key_list = tag_key list
type nonrec untag_resource_request = {
  1. tag_keys : tag_key_list;
    (*

    The keys of the tags to be removed.

    *)
  2. resource_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resource is an Amazon ECR Public repository.

    *)
}
type nonrec too_many_tags_exception = {
  1. message : exception_message option;
}

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.

type nonrec invalid_tag_parameter_exception = {
  1. message : exception_message option;
}

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.

type nonrec tag_value = string
type nonrec tag_resource_response = unit
type nonrec tag = {
  1. value : tag_value option;
    (*

    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    *)
  2. key : tag_key option;
    (*

    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 that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. 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 list
type nonrec tag_resource_request = {
  1. tags : tag_list;
    (*

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    *)
  2. resource_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resource is an Amazon ECR Public repository.

    *)
}
type nonrec repository_policy_text = string
type nonrec set_repository_policy_response = {
  1. policy_text : repository_policy_text option;
    (*

    The JSON repository policy text that's applied to the repository.

    *)
  2. repository_name : repository_name option;
    (*

    The repository name that's associated with the request.

    *)
  3. registry_id : registry_id option;
    (*

    The registry ID that's associated with the request.

    *)
}
type nonrec force_flag = bool
type nonrec set_repository_policy_request = {
  1. force : force_flag option;
    (*

    If the policy that you want to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This prevents accidental repository lockouts.

    *)
  2. 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.

    *)
  3. repository_name : repository_name;
    (*

    The name of the repository to receive the policy.

    *)
  4. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the registry that contains the repository. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec repository_description = string
type nonrec architecture = string
type nonrec architecture_list = architecture list
type nonrec operating_system = string
type nonrec operating_system_list = operating_system list
type nonrec resource_url = string
type nonrec about_text = string
type nonrec marketplace_certified = bool
type nonrec repository_catalog_data = {
  1. marketplace_certified : marketplace_certified option;
    (*

    Indicates whether the repository is certified by Amazon Web Services Marketplace.

    *)
  2. usage_text : usage_text option;
    (*

    The longform usage details of the contents of the repository. The usage text provides context for users of the repository.

    *)
  3. about_text : about_text option;
    (*

    The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.

    *)
  4. logo_url : resource_url option;
    (*

    The URL that contains the logo that's associated with the repository.

    *)
  5. operating_systems : operating_system_list option;
    (*

    The operating system tags that are associated with the repository.

    Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.

    *)
  6. architectures : architecture_list option;
    (*

    The architecture tags that are associated with the repository.

    Only supported operating system tags appear publicly in the Amazon ECR Public Gallery. For more information, see RepositoryCatalogDataInput.

    *)
  7. description : repository_description option;
    (*

    The short description of the repository.

    *)
}

The catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

type nonrec put_repository_catalog_data_response = {
  1. catalog_data : repository_catalog_data option;
    (*

    The catalog data for the repository.

    *)
}
type nonrec logo_image_blob = bytes
type nonrec repository_catalog_data_input = {
  1. usage_text : usage_text option;
    (*

    Detailed information about how to use the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.

    *)
  2. about_text : about_text option;
    (*

    A detailed description of the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.

    *)
  3. logo_image_blob : logo_image_blob option;
    (*

    The base64-encoded repository logo payload.

    The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.

    *)
  4. operating_systems : operating_system_list option;
    (*

    The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems appear as badges on the repository and are used as search filters.

    If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.

    • Linux
    • Windows
    *)
  5. architectures : architecture_list option;
    (*

    The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures appear as badges on the repository and are used as search filters.

    If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.

    • ARM
    • ARM 64
    • x86
    • x86-64
    *)
  6. description : repository_description option;
    (*

    A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.

    *)
}

An object that contains the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

type nonrec put_repository_catalog_data_request = {
  1. catalog_data : repository_catalog_data_input;
    (*

    An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.

    *)
  2. repository_name : repository_name;
    (*

    The name of the repository to create or update the catalog data for.

    *)
  3. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry the repository is in. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec registry_display_name = string
type nonrec registry_catalog_data = {
  1. display_name : registry_display_name option;
    (*

    The display name for a public registry. This appears on the Amazon ECR Public Gallery.

    Only accounts that have the verified account badge can have a registry display name.

    *)
}

The metadata for a public registry.

type nonrec put_registry_catalog_data_response = {
  1. registry_catalog_data : registry_catalog_data;
    (*

    The catalog data for the public registry.

    *)
}
type nonrec put_registry_catalog_data_request = {
  1. display_name : registry_display_name option;
    (*

    The display name for a public registry. The display name is shown as the repository author in the Amazon ECR Public Gallery.

    The registry display name is only publicly visible in the Amazon ECR Public Gallery for verified accounts.

    *)
}
type nonrec referenced_images_not_found_exception = {
  1. message : exception_message option;
}

The manifest list is referencing an image that doesn't exist.

type nonrec layers_not_found_exception = {
  1. message : exception_message option;
}

The specified layers can't be found, or the specified layer isn't valid for this repository.

type nonrec image_tag_already_exists_exception = {
  1. message : exception_message option;
}

The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.

type nonrec image_digest_does_not_match_exception = {
  1. message : exception_message option;
}

The specified image digest doesn't match the digest that Amazon ECR calculated for the image.

type nonrec image_already_exists_exception = {
  1. message : exception_message option;
}

The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.

type nonrec image_digest = string
type nonrec image_tag = string
type nonrec image_identifier = {
  1. image_tag : image_tag option;
    (*

    The tag that's used for the image.

    *)
  2. image_digest : image_digest option;
    (*

    The sha256 digest of the image manifest.

    *)
}

An object with identifying information for an Amazon ECR image.

type nonrec image_manifest = string
type nonrec media_type = string
type nonrec image = {
  1. image_manifest_media_type : media_type option;
    (*

    The manifest media type of the image.

    *)
  2. image_manifest : image_manifest option;
    (*

    The image manifest that's associated with the image.

    *)
  3. image_id : image_identifier option;
    (*

    An object that contains the image tag and image digest associated with an image.

    *)
  4. repository_name : repository_name option;
    (*

    The name of the repository that's associated with the image.

    *)
  5. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID that's associated with the registry containing the image.

    *)
}

An object that represents an Amazon ECR image.

type nonrec put_image_response = {
  1. image : image option;
    (*

    Details of the image uploaded.

    *)
}
type nonrec put_image_request = {
  1. image_digest : image_digest option;
    (*

    The image digest of the image manifest that corresponds to the image.

    *)
  2. image_tag : image_tag option;
    (*

    The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or Open Container Initiative (OCI) formats.

    *)
  3. image_manifest_media_type : media_type option;
    (*

    The media type of the image manifest. If you push an image manifest that doesn't contain the mediaType field, you must specify the imageManifestMediaType in the request.

    *)
  4. image_manifest : image_manifest;
    (*

    The image manifest that corresponds to the image to be uploaded.

    *)
  5. repository_name : repository_name;
    (*

    The name of the repository where the image is put.

    *)
  6. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, that's associated with the public registry that contains the repository where the image is put. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec list_tags_for_resource_response = {
  1. tags : tag_list option;
    (*

    The tags for the resource.

    *)
}
type nonrec list_tags_for_resource_request = {
  1. resource_arn : arn;
    (*

    The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resource is an Amazon ECR Public repository.

    *)
}
type nonrec initiate_layer_upload_response = {
  1. part_size : part_size option;
    (*

    The size, in bytes, that Amazon ECR expects future layer part uploads to be.

    *)
  2. 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 = {
  1. repository_name : repository_name;
    (*

    The name of the repository that you want to upload layers to.

    *)
  2. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, that's associated with the registry to which you intend to upload layers. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec repository_policy_not_found_exception = {
  1. message : exception_message option;
}

The specified repository and registry combination doesn't have an associated repository policy.

type nonrec get_repository_policy_response = {
  1. policy_text : repository_policy_text option;
    (*

    The repository policy text that's associated with the repository. The policy text will be in JSON format.

    *)
  2. repository_name : repository_name option;
    (*

    The repository name that's associated with the request.

    *)
  3. registry_id : registry_id option;
    (*

    The registry ID that's associated with the request.

    *)
}
type nonrec get_repository_policy_request = {
  1. repository_name : repository_name;
    (*

    The name of the repository with the policy to retrieve.

    *)
  2. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec repository_catalog_data_not_found_exception = {
  1. message : exception_message option;
}

The repository catalog data doesn't exist.

type nonrec get_repository_catalog_data_response = {
  1. catalog_data : repository_catalog_data option;
    (*

    The catalog metadata for the repository.

    *)
}
type nonrec get_repository_catalog_data_request = {
  1. repository_name : repository_name;
    (*

    The name of the repository to retrieve the catalog metadata for.

    *)
  2. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec get_registry_catalog_data_response = {
  1. registry_catalog_data : registry_catalog_data;
    (*

    The catalog metadata for the public registry.

    *)
}
type nonrec get_registry_catalog_data_request = unit
type nonrec base64 = string
type nonrec expiration_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec authorization_data = {
  1. expires_at : expiration_timestamp option;
    (*

    The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

    *)
  2. authorization_token : base64 option;
    (*

    A base64-encoded string that contains authorization data for a public Amazon ECR registry. When the string is decoded, it's presented in the format user:password for public registry authentication using docker login.

    *)
}

An authorization token data object that corresponds to a public registry.

type nonrec get_authorization_token_response = {
  1. authorization_data : authorization_data option;
    (*

    An authorization token data object that corresponds to a public registry.

    *)
}
type nonrec get_authorization_token_request = unit
type nonrec creation_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec repository = {
  1. created_at : creation_timestamp option;
    (*

    The date and time, in JavaScript date format, when the repository was created.

    *)
  2. repository_uri : url option;
    (*

    The URI for the repository. You can use this URI for container image push and pull operations.

    *)
  3. repository_name : repository_name option;
    (*

    The name of the repository.

    *)
  4. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository.

    *)
  5. 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/test.

    *)
}

An object representing a repository.

type nonrec repository_list = repository list
type nonrec next_token = string
type nonrec describe_repositories_response = {
  1. 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. If there are no more results to return, this value is null.

    *)
  2. repositories : repository_list option;
    (*

    A list of repository objects corresponding to valid repositories.

    *)
}
type nonrec repository_name_list = repository_name list
type nonrec max_results = int
type nonrec describe_repositories_request = {
  1. max_results : max_results option;
    (*

    The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. If you specify repositories with repositoryNames, you can't use this option.

    *)
  2. next_token : next_token option;
    (*

    The nextToken value that's 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. If there are no more results to return, this value is null. If you specify repositories with repositoryNames, you can't use this option.

    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.

    *)
  3. 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.

    *)
  4. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec registry_verified = bool
type nonrec registry_alias_name = string
type nonrec registry_alias_status =
  1. | REJECTED
  2. | PENDING
  3. | ACTIVE
type nonrec primary_registry_alias_flag = bool
type nonrec default_registry_alias_flag = bool
type nonrec registry_alias = {
  1. default_registry_alias : default_registry_alias_flag;
    (*

    Indicates whether the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias.

    *)
  2. primary_registry_alias : primary_registry_alias_flag;
    (*

    Indicates whether the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the docker pull commands on the Amazon ECR Public Gallery.

    A registry alias that isn't the primary registry alias can be used in the repository URI in a docker pull command.

    *)
  3. status : registry_alias_status;
    (*

    The status of the registry alias.

    *)
  4. name : registry_alias_name;
    (*

    The name of the registry alias.

    *)
}

An object representing the aliases for a public registry. A public registry is given an alias when it's created. However, a custom alias can be set using the Amazon ECR console. For more information, see Registries in the Amazon Elastic Container Registry User Guide.

type nonrec registry_alias_list = registry_alias list
type nonrec registry = {
  1. aliases : registry_alias_list;
    (*

    An array of objects that represents the aliases for a public registry.

    *)
  2. verified : registry_verified;
    (*

    Indicates whether the account is a verified Amazon Web Services Marketplace vendor. If an account is verified, each public repository receives a verified account badge on the Amazon ECR Public Gallery.

    *)
  3. registry_uri : url;
    (*

    The URI of a public registry. The URI contains a universal prefix and the registry alias.

    *)
  4. registry_arn : arn;
    (*

    The Amazon Resource Name (ARN) of the public registry.

    *)
  5. registry_id : registry_id;
    (*

    The Amazon Web Services account ID that's associated with the registry. If you do not specify a registry, the default public registry is assumed.

    *)
}

The details of a public registry.

type nonrec registry_list = registry list
type nonrec describe_registries_response = {
  1. next_token : next_token option;
    (*

    The nextToken value to include in a future DescribeRepositories request. If the results of a DescribeRepositories request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results, this value is null.

    *)
  2. registries : registry_list;
    (*

    An object that contains the details for a public registry.

    *)
}
type nonrec describe_registries_request = {
  1. max_results : max_results option;
    (*

    The maximum number of repository results that's returned by DescribeRegistries in paginated output. When this parameter is used, DescribeRegistries 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 DescribeRegistries request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeRegistries returns up to 100 results and a nextToken value, if applicable.

    *)
  2. next_token : next_token option;
    (*

    The nextToken value that's returned from a previous paginated DescribeRegistries 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. If there are no more results to return, this value is null.

    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.

    *)
}
type nonrec image_size_in_bytes = Smaws_Lib.CoreTypes.Int64.t
type nonrec push_timestamp = Smaws_Lib.CoreTypes.Timestamp.t
type nonrec referenced_image_detail = {
  1. artifact_media_type : media_type option;
    (*

    The artifact media type of the image.

    *)
  2. image_manifest_media_type : media_type option;
    (*

    The media type of the image manifest.

    *)
  3. image_pushed_at : push_timestamp option;
    (*

    The date and time, expressed in standard JavaScript date format, which the current image tag was pushed to the repository at.

    *)
  4. 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 is the max size of all manifests in the list.

    Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it might return a larger image size than the image sizes that are returned by DescribeImages.

    *)
  5. image_digest : image_digest option;
    (*

    The sha256 digest of the image manifest.

    *)
}

An object that describes the image tag details that are returned by a DescribeImageTags action.

type nonrec image_tag_detail = {
  1. image_detail : referenced_image_detail option;
    (*

    An object that describes the details of an image.

    *)
  2. created_at : creation_timestamp option;
    (*

    The time stamp that indicates when the image tag was created.

    *)
  3. image_tag : image_tag option;
    (*

    The tag that's associated with the image.

    *)
}

An object that represents the image tag details for an image.

type nonrec image_tag_detail_list = image_tag_detail list
type nonrec describe_image_tags_response = {
  1. next_token : next_token option;
    (*

    The nextToken value to include in a future DescribeImageTags request. When the results of a DescribeImageTags request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

    *)
  2. image_tag_details : image_tag_detail_list option;
    (*

    The image tag details for the images in the requested repository.

    *)
}
type nonrec describe_image_tags_request = {
  1. max_results : max_results option;
    (*

    The maximum number of repository results that's returned by DescribeImageTags in paginated output. When this parameter is used, DescribeImageTags only returns maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another DescribeImageTags request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImageTags returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

    *)
  2. next_token : next_token option;
    (*

    The nextToken value that's returned from a previous paginated DescribeImageTags 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

    *)
  3. repository_name : repository_name;
    (*

    The name of the repository that contains the image tag details to describe.

    *)
  4. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec image_not_found_exception = {
  1. message : exception_message option;
}

The image requested doesn't exist in the specified repository.

type nonrec image_tag_list = image_tag list
type nonrec image_detail = {
  1. artifact_media_type : media_type option;
    (*

    The artifact media type of the image.

    *)
  2. image_manifest_media_type : media_type option;
    (*

    The media type of the image manifest.

    *)
  3. image_pushed_at : push_timestamp option;
    (*

    The date and time, expressed in standard JavaScript date format, that the current image was pushed to the repository at.

    *)
  4. 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 is the max size of all manifests in the list.

    Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it might return a larger image size than the image sizes that are returned by DescribeImages.

    *)
  5. image_tags : image_tag_list option;
    (*

    The list of tags that's associated with this image.

    *)
  6. image_digest : image_digest option;
    (*

    The sha256 digest of the image manifest.

    *)
  7. repository_name : repository_name option;
    (*

    The name of the repository where this image belongs.

    *)
  8. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry where this image belongs.

    *)
}

An object that describes an image that's returned by a DescribeImages operation.

type nonrec image_detail_list = image_detail list
type nonrec describe_images_response = {
  1. next_token : next_token option;
    (*

    The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, you can use this value to retrieve the next page of results. If there are no more results to return, this value is null.

    *)
  2. image_details : image_detail_list option;
    (*

    A list of ImageDetail objects that contain data about the image.

    *)
}
type nonrec image_identifier_list = image_identifier list
type nonrec describe_images_request = {
  1. max_results : max_results option;
    (*

    The maximum number of repository results that's 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. You can see the remaining results of the initial request by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. If you specify images with imageIds, you can't use this option.

    *)
  2. next_token : next_token option;
    (*

    The nextToken value that's 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. If there are no more results to return, this value is null. If you specify images with imageIds, you can't use this option.

    *)
  3. image_ids : image_identifier_list option;
    (*

    The list of image IDs for the requested repository.

    *)
  4. repository_name : repository_name;
    (*

    The repository that contains the images to describe.

    *)
  5. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository where images are described. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec delete_repository_policy_response = {
  1. policy_text : repository_policy_text option;
    (*

    The JSON repository policy that was deleted from the repository.

    *)
  2. repository_name : repository_name option;
    (*

    The repository name that's associated with the request.

    *)
  3. registry_id : registry_id option;
    (*

    The registry ID that's associated with the request.

    *)
}
type nonrec delete_repository_policy_request = {
  1. repository_name : repository_name;
    (*

    The name of the repository that's associated with the repository policy to delete.

    *)
  2. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository policy to delete. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec repository_not_empty_exception = {
  1. message : exception_message option;
}

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

type nonrec delete_repository_response = {
  1. repository : repository option;
    (*

    The repository that was deleted.

    *)
}
type nonrec delete_repository_request = {
  1. force : force_flag option;
    (*

    The force option can be used to delete a repository that contains images. If the force option is not used, the repository must be empty prior to deletion.

    *)
  2. repository_name : repository_name;
    (*

    The name of the repository to delete.

    *)
  3. registry_id : registry_id option;
    (*

    The Amazon Web Services account ID that's associated with the public registry that contains the repository to delete. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec repository_already_exists_exception = {
  1. message : exception_message option;
}

The specified repository already exists in the specified registry.

type nonrec create_repository_response = {
  1. catalog_data : repository_catalog_data option;
  2. repository : repository option;
    (*

    The repository that was created.

    *)
}
type nonrec create_repository_request = {
  1. tags : tag_list option;
    (*

    The metadata that you apply to each repository to help categorize and organize your repositories. Each tag consists of a key and an optional value. You define both of them. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    *)
  2. catalog_data : repository_catalog_data_input option;
    (*

    The details about the repository that are publicly visible in the Amazon ECR Public Gallery.

    *)
  3. repository_name : repository_name;
    (*

    The name to use for the repository. This appears publicly in the Amazon ECR Public Gallery. The repository name can be specified on its own (for example nginx-web-app) or prepended with a namespace to group the repository into a category (for example project-a/nginx-web-app).

    *)
}
type nonrec layer_part_too_small_exception = {
  1. message : exception_message option;
}

Layer parts must be at least 5 MiB in size.

type nonrec layer_already_exists_exception = {
  1. message : exception_message option;
}

The image layer already exists in the associated repository.

type nonrec invalid_layer_exception = {
  1. message : exception_message option;
}

The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest specified.

type nonrec empty_upload_exception = {
  1. message : exception_message option;
}

The specified layer upload doesn't contain any layer parts.

type nonrec layer_digest = string
type nonrec complete_layer_upload_response = {
  1. layer_digest : layer_digest option;
    (*

    The sha256 digest of the image layer.

    *)
  2. upload_id : upload_id option;
    (*

    The upload ID that's associated with the layer.

    *)
  3. repository_name : repository_name option;
    (*

    The repository name that's associated with the request.

    *)
  4. registry_id : registry_id option;
    (*

    The public registry ID that's associated with the request.

    *)
}
type nonrec layer_digest_list = layer_digest list
type nonrec complete_layer_upload_request = {
  1. layer_digests : layer_digest_list;
    (*

    The sha256 digest of the image layer.

    *)
  2. upload_id : upload_id;
    (*

    The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.

    *)
  3. repository_name : repository_name;
    (*

    The name of the repository in a public registry to associate with the image layer.

    *)
  4. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, associated with the registry where layers are uploaded. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec image_failure_code =
  1. | KmsError
  2. | ImageReferencedByManifestList
  3. | MissingDigestAndTag
  4. | ImageNotFound
  5. | ImageTagDoesNotMatchDigest
  6. | InvalidImageTag
  7. | InvalidImageDigest
type nonrec image_failure_reason = string
type nonrec image_failure = {
  1. failure_reason : image_failure_reason option;
    (*

    The reason for the failure.

    *)
  2. failure_code : image_failure_code option;
    (*

    The code that's associated with the failure.

    *)
  3. image_id : image_identifier option;
    (*

    The image ID that's associated with the failure.

    *)
}

An object that represents an Amazon ECR image failure.

type nonrec image_failure_list = image_failure list
type nonrec batch_delete_image_response = {
  1. failures : image_failure_list option;
    (*

    Any failures associated with the call.

    *)
  2. image_ids : image_identifier_list option;
    (*

    The image IDs of the deleted images.

    *)
}
type nonrec batch_delete_image_request = {
  1. 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.

    *)
  2. repository_name : repository_name;
    (*

    The repository in a public registry that contains the image to delete.

    *)
  3. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, that's associated with the registry that contains the image to delete. If you do not specify a registry, the default public registry is assumed.

    *)
}
type nonrec layer_availability =
  1. | UNAVAILABLE
  2. | AVAILABLE
type nonrec layer_size_in_bytes = Smaws_Lib.CoreTypes.Int64.t
type nonrec layer = {
  1. 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.

    *)
  2. layer_size : layer_size_in_bytes option;
    (*

    The size, in bytes, of the image layer.

    *)
  3. layer_availability : layer_availability option;
    (*

    The availability status of the image layer.

    *)
  4. layer_digest : layer_digest option;
    (*

    The sha256 digest of the image layer.

    *)
}

An object that represents an Amazon ECR image layer.

type nonrec layer_list = layer list
type nonrec batched_operation_layer_digest = string
type nonrec layer_failure_code =
  1. | MissingLayerDigest
  2. | InvalidLayerDigest
type nonrec layer_failure_reason = string
type nonrec layer_failure = {
  1. failure_reason : layer_failure_reason option;
    (*

    The reason for the failure.

    *)
  2. failure_code : layer_failure_code option;
    (*

    The failure code that's associated with the failure.

    *)
  3. layer_digest : batched_operation_layer_digest option;
    (*

    The layer digest that's associated with the failure.

    *)
}

An object that represents an Amazon ECR image layer failure.

type nonrec layer_failure_list = layer_failure list
type nonrec batch_check_layer_availability_response = {
  1. failures : layer_failure_list option;
    (*

    Any failures associated with the call.

    *)
  2. layers : layer_list option;
    (*

    A list of image layer objects that correspond to the image layer references in the request.

    *)
}
type nonrec batched_operation_layer_digest_list = batched_operation_layer_digest list
type nonrec batch_check_layer_availability_request = {
  1. layer_digests : batched_operation_layer_digest_list;
    (*

    The digests of the image layers to check.

    *)
  2. repository_name : repository_name;
    (*

    The name of the repository that's associated with the image layers to check.

    *)
  3. registry_id : registry_id_or_alias option;
    (*

    The Amazon Web Services account ID, or registry alias, associated with the public registry that contains the image layers to check. If you do not specify a registry, the default public registry is assumed.

    *)
}