libZSservicesZSamazonka-ecrZSamazonka-ecr
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECR.Lens

Description

 
Synopsis

Operations

GetRepositoryPolicy

getRepositoryPolicy_registryId :: Lens' GetRepositoryPolicy (Maybe Text) Source #

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.

getRepositoryPolicy_repositoryName :: Lens' GetRepositoryPolicy Text Source #

The name of the repository with the policy to retrieve.

getRepositoryPolicyResponse_policyText :: Lens' GetRepositoryPolicyResponse (Maybe Text) Source #

The JSON repository policy text associated with the repository.

PutImageScanningConfiguration

putImageScanningConfiguration_registryId :: Lens' PutImageScanningConfiguration (Maybe Text) Source #

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.

putImageScanningConfiguration_repositoryName :: Lens' PutImageScanningConfiguration Text Source #

The name of the repository in which to update the image scanning configuration setting.

putImageScanningConfiguration_imageScanningConfiguration :: Lens' PutImageScanningConfiguration ImageScanningConfiguration Source #

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.

PutLifecyclePolicy

putLifecyclePolicy_registryId :: Lens' PutLifecyclePolicy (Maybe Text) Source #

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.

putLifecyclePolicy_repositoryName :: Lens' PutLifecyclePolicy Text Source #

The name of the repository to receive the policy.

putLifecyclePolicy_lifecyclePolicyText :: Lens' PutLifecyclePolicy Text Source #

The JSON repository policy text to apply to the repository.

putLifecyclePolicyResponse_repositoryName :: Lens' PutLifecyclePolicyResponse (Maybe Text) Source #

The repository name associated with the request.

DeleteLifecyclePolicy

deleteLifecyclePolicy_registryId :: Lens' DeleteLifecyclePolicy (Maybe Text) Source #

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.

deleteLifecyclePolicyResponse_lastEvaluatedAt :: Lens' DeleteLifecyclePolicyResponse (Maybe UTCTime) Source #

The time stamp of the last time that the lifecycle policy was run.

PutImageTagMutability

putImageTagMutability_registryId :: Lens' PutImageTagMutability (Maybe Text) Source #

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.

putImageTagMutability_repositoryName :: Lens' PutImageTagMutability Text Source #

The name of the repository in which to update the image tag mutability settings.

putImageTagMutability_imageTagMutability :: Lens' PutImageTagMutability ImageTagMutability Source #

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.

BatchDeleteImage

batchDeleteImage_registryId :: Lens' BatchDeleteImage (Maybe Text) Source #

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.

batchDeleteImage_repositoryName :: Lens' BatchDeleteImage Text Source #

The repository that contains the image to delete.

batchDeleteImage_imageIds :: Lens' BatchDeleteImage [ImageIdentifier] Source #

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

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

GetLifecyclePolicyPreview

getLifecyclePolicyPreview_registryId :: Lens' GetLifecyclePolicyPreview (Maybe Text) Source #

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.

getLifecyclePolicyPreview_nextToken :: Lens' GetLifecyclePolicyPreview (Maybe Text) Source #

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.

getLifecyclePolicyPreview_filter :: Lens' GetLifecyclePolicyPreview (Maybe LifecyclePolicyPreviewFilter) Source #

An optional parameter that filters results based on image tag status and all tags, if tagged.

getLifecyclePolicyPreview_maxResults :: Lens' GetLifecyclePolicyPreview (Maybe Natural) Source #

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 1000. 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.

getLifecyclePolicyPreviewResponse_nextToken :: Lens' GetLifecyclePolicyPreviewResponse (Maybe Text) Source #

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.

BatchCheckLayerAvailability

batchCheckLayerAvailability_registryId :: Lens' BatchCheckLayerAvailability (Maybe Text) Source #

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.

batchCheckLayerAvailability_repositoryName :: Lens' BatchCheckLayerAvailability Text Source #

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

batchCheckLayerAvailabilityResponse_layers :: Lens' BatchCheckLayerAvailabilityResponse (Maybe [Layer]) Source #

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

DescribeRegistry

DeleteRepositoryPolicy

deleteRepositoryPolicy_registryId :: Lens' DeleteRepositoryPolicy (Maybe Text) Source #

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.

deleteRepositoryPolicy_repositoryName :: Lens' DeleteRepositoryPolicy Text Source #

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

deleteRepositoryPolicyResponse_policyText :: Lens' DeleteRepositoryPolicyResponse (Maybe Text) Source #

The JSON repository policy that was deleted from the repository.

CreateRepository

createRepository_registryId :: Lens' CreateRepository (Maybe Text) Source #

The AWS account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.

createRepository_imageScanningConfiguration :: Lens' CreateRepository (Maybe ImageScanningConfiguration) Source #

The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

createRepository_encryptionConfiguration :: Lens' CreateRepository (Maybe EncryptionConfiguration) Source #

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

createRepository_imageTagMutability :: Lens' CreateRepository (Maybe ImageTagMutability) Source #

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.

createRepository_tags :: Lens' CreateRepository (Maybe [Tag]) Source #

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

createRepository_repositoryName :: Lens' CreateRepository Text Source #

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

CompleteLayerUpload

completeLayerUpload_registryId :: Lens' CompleteLayerUpload (Maybe Text) Source #

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.

completeLayerUpload_repositoryName :: Lens' CompleteLayerUpload Text Source #

The name of the repository to associate with the image layer.

completeLayerUpload_uploadId :: Lens' CompleteLayerUpload Text Source #

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

DescribeRepositories

describeRepositories_registryId :: Lens' DescribeRepositories (Maybe Text) Source #

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.

describeRepositories_repositoryNames :: Lens' DescribeRepositories (Maybe (NonEmpty Text)) Source #

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

describeRepositories_nextToken :: Lens' DescribeRepositories (Maybe Text) Source #

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.

describeRepositories_maxResults :: Lens' DescribeRepositories (Maybe Natural) Source #

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.

describeRepositoriesResponse_repositories :: Lens' DescribeRepositoriesResponse (Maybe [Repository]) Source #

A list of repository objects corresponding to valid repositories.

describeRepositoriesResponse_nextToken :: Lens' DescribeRepositoriesResponse (Maybe Text) Source #

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.

StartLifecyclePolicyPreview

startLifecyclePolicyPreview_registryId :: Lens' StartLifecyclePolicyPreview (Maybe Text) Source #

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.

startLifecyclePolicyPreview_lifecyclePolicyText :: Lens' StartLifecyclePolicyPreview (Maybe Text) Source #

The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

DeleteRegistryPolicy

deleteRegistryPolicyResponse_policyText :: Lens' DeleteRegistryPolicyResponse (Maybe Text) Source #

The contents of the registry permissions policy that was deleted.

PutRegistryPolicy

putRegistryPolicy_policyText :: Lens' PutRegistryPolicy Text Source #

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.

UploadLayerPart

uploadLayerPart_registryId :: Lens' UploadLayerPart (Maybe Text) Source #

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.

uploadLayerPart_repositoryName :: Lens' UploadLayerPart Text Source #

The name of the repository to which you are uploading layer parts.

uploadLayerPart_uploadId :: Lens' UploadLayerPart Text Source #

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

uploadLayerPart_partFirstByte :: Lens' UploadLayerPart Natural Source #

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

uploadLayerPart_partLastByte :: Lens' UploadLayerPart Natural Source #

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

uploadLayerPart_layerPartBlob :: Lens' UploadLayerPart ByteString Source #

The base64-encoded layer part payload.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

uploadLayerPartResponse_registryId :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The registry ID associated with the request.

uploadLayerPartResponse_lastByteReceived :: Lens' UploadLayerPartResponse (Maybe Natural) Source #

The integer value of the last byte received in the request.

uploadLayerPartResponse_repositoryName :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The repository name associated with the request.

uploadLayerPartResponse_uploadId :: Lens' UploadLayerPartResponse (Maybe Text) Source #

The upload ID associated with the request.

DescribeImageReplicationStatus

describeImageReplicationStatus_registryId :: Lens' DescribeImageReplicationStatus (Maybe Text) Source #

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

BatchGetImage

batchGetImage_registryId :: Lens' BatchGetImage (Maybe Text) Source #

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.

batchGetImage_acceptedMediaTypes :: Lens' BatchGetImage (Maybe (NonEmpty Text)) Source #

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

batchGetImage_repositoryName :: Lens' BatchGetImage Text Source #

The repository that contains the images to describe.

batchGetImage_imageIds :: Lens' BatchGetImage [ImageIdentifier] Source #

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

batchGetImageResponse_images :: Lens' BatchGetImageResponse (Maybe [Image]) Source #

A list of image objects corresponding to the image references in the request.

PutReplicationConfiguration

StartImageScan

startImageScan_registryId :: Lens' StartImageScan (Maybe Text) Source #

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.

startImageScan_repositoryName :: Lens' StartImageScan Text Source #

The name of the repository that contains the images to scan.

startImageScanResponse_registryId :: Lens' StartImageScanResponse (Maybe Text) Source #

The registry ID associated with the request.

startImageScanResponse_repositoryName :: Lens' StartImageScanResponse (Maybe Text) Source #

The repository name associated with the request.

GetLifecyclePolicy

getLifecyclePolicy_registryId :: Lens' GetLifecyclePolicy (Maybe Text) Source #

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.

getLifecyclePolicyResponse_lastEvaluatedAt :: Lens' GetLifecyclePolicyResponse (Maybe UTCTime) Source #

The time stamp of the last time that the lifecycle policy was run.

getLifecyclePolicyResponse_repositoryName :: Lens' GetLifecyclePolicyResponse (Maybe Text) Source #

The repository name associated with the request.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

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

tagResource_tags :: Lens' TagResource [Tag] Source #

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.

SetRepositoryPolicy

setRepositoryPolicy_force :: Lens' SetRepositoryPolicy (Maybe Bool) Source #

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.

setRepositoryPolicy_registryId :: Lens' SetRepositoryPolicy (Maybe Text) Source #

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.

setRepositoryPolicy_repositoryName :: Lens' SetRepositoryPolicy Text Source #

The name of the repository to receive the policy.

setRepositoryPolicy_policyText :: Lens' SetRepositoryPolicy Text Source #

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.

setRepositoryPolicyResponse_policyText :: Lens' SetRepositoryPolicyResponse (Maybe Text) Source #

The JSON repository policy text applied to the repository.

DescribeImageScanFindings

describeImageScanFindings_registryId :: Lens' DescribeImageScanFindings (Maybe Text) Source #

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.

describeImageScanFindings_nextToken :: Lens' DescribeImageScanFindings (Maybe Text) Source #

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.

describeImageScanFindings_maxResults :: Lens' DescribeImageScanFindings (Maybe Natural) Source #

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.

describeImageScanFindings_repositoryName :: Lens' DescribeImageScanFindings Text Source #

The repository for the image for which to describe the scan findings.

describeImageScanFindingsResponse_nextToken :: Lens' DescribeImageScanFindingsResponse (Maybe Text) Source #

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.

InitiateLayerUpload

initiateLayerUpload_registryId :: Lens' InitiateLayerUpload (Maybe Text) Source #

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.

initiateLayerUpload_repositoryName :: Lens' InitiateLayerUpload Text Source #

The name of the repository to which you intend to upload layers.

initiateLayerUploadResponse_partSize :: Lens' InitiateLayerUploadResponse (Maybe Natural) Source #

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

initiateLayerUploadResponse_uploadId :: Lens' InitiateLayerUploadResponse (Maybe Text) Source #

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

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

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The keys of the tags to be removed.

DeleteRepository

deleteRepository_force :: Lens' DeleteRepository (Maybe Bool) Source #

If a repository contains images, forces the deletion.

deleteRepository_registryId :: Lens' DeleteRepository (Maybe Text) Source #

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.

deleteRepository_repositoryName :: Lens' DeleteRepository Text Source #

The name of the repository to delete.

GetRegistryPolicy

getRegistryPolicyResponse_policyText :: Lens' GetRegistryPolicyResponse (Maybe Text) Source #

The JSON text of the permissions policy for a registry.

PutImage

putImage_registryId :: Lens' PutImage (Maybe Text) Source #

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.

putImage_imageManifestMediaType :: Lens' PutImage (Maybe Text) Source #

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.

putImage_imageDigest :: Lens' PutImage (Maybe Text) Source #

The image digest of the image manifest corresponding to the image.

putImage_imageTag :: Lens' PutImage (Maybe Text) Source #

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.

putImage_repositoryName :: Lens' PutImage Text Source #

The name of the repository in which to put the image.

putImage_imageManifest :: Lens' PutImage Text Source #

The image manifest corresponding to the image to be uploaded.

putImageResponse_image :: Lens' PutImageResponse (Maybe Image) Source #

Details of the image uploaded.

putImageResponse_httpStatus :: Lens' PutImageResponse Int Source #

The response's http status code.

ListImages

listImages_registryId :: Lens' ListImages (Maybe Text) Source #

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.

listImages_nextToken :: Lens' ListImages (Maybe Text) Source #

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.

listImages_filter :: Lens' ListImages (Maybe ListImagesFilter) Source #

The filter key and value with which to filter your ListImages results.

listImages_maxResults :: Lens' ListImages (Maybe Natural) Source #

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.

listImages_repositoryName :: Lens' ListImages Text Source #

The repository with image IDs to be listed.

listImagesResponse_imageIds :: Lens' ListImagesResponse (Maybe [ImageIdentifier]) Source #

The list of image IDs for the requested repository.

listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text) Source #

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.

GetAuthorizationToken

getAuthorizationToken_registryIds :: Lens' GetAuthorizationToken (Maybe (NonEmpty Text)) Source #

A list of Amazon Web Services account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed.

getAuthorizationTokenResponse_authorizationData :: Lens' GetAuthorizationTokenResponse (Maybe [AuthorizationData]) Source #

A list of authorization token data objects that correspond to the registryIds values in the request.

GetDownloadUrlForLayer

getDownloadUrlForLayer_registryId :: Lens' GetDownloadUrlForLayer (Maybe Text) Source #

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.

getDownloadUrlForLayer_repositoryName :: Lens' GetDownloadUrlForLayer Text Source #

The name of the repository that is associated with the image layer to download.

getDownloadUrlForLayer_layerDigest :: Lens' GetDownloadUrlForLayer Text Source #

The digest of the image layer to download.

getDownloadUrlForLayerResponse_downloadUrl :: Lens' GetDownloadUrlForLayerResponse (Maybe Text) Source #

The pre-signed Amazon S3 download URL for the requested layer.

DescribeImages

describeImages_registryId :: Lens' DescribeImages (Maybe Text) Source #

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.

describeImages_imageIds :: Lens' DescribeImages (Maybe [ImageIdentifier]) Source #

The list of image IDs for the requested repository.

describeImages_nextToken :: Lens' DescribeImages (Maybe Text) Source #

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.

describeImages_filter :: Lens' DescribeImages (Maybe DescribeImagesFilter) Source #

The filter key and value with which to filter your DescribeImages results.

describeImages_maxResults :: Lens' DescribeImages (Maybe Natural) Source #

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.

describeImages_repositoryName :: Lens' DescribeImages Text Source #

The repository that contains the images to describe.

describeImagesResponse_imageDetails :: Lens' DescribeImagesResponse (Maybe [ImageDetail]) Source #

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

describeImagesResponse_nextToken :: Lens' DescribeImagesResponse (Maybe Text) Source #

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.

Types

Attribute

attribute_value :: Lens' Attribute (Maybe Text) Source #

The value assigned to the attribute key.

attribute_key :: Lens' Attribute Text Source #

The attribute key.

AuthorizationData

authorizationData_expiresAt :: Lens' AuthorizationData (Maybe UTCTime) Source #

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

authorizationData_proxyEndpoint :: Lens' AuthorizationData (Maybe Text) Source #

The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

authorizationData_authorizationToken :: Lens' AuthorizationData (Maybe Text) Source #

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

DescribeImagesFilter

describeImagesFilter_tagStatus :: Lens' DescribeImagesFilter (Maybe TagStatus) Source #

The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

EncryptionConfiguration

encryptionConfiguration_kmsKey :: Lens' EncryptionConfiguration (Maybe Text) Source #

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.

encryptionConfiguration_encryptionType :: Lens' EncryptionConfiguration EncryptionType Source #

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 AES-256 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..

Image

image_registryId :: Lens' Image (Maybe Text) Source #

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

image_imageManifestMediaType :: Lens' Image (Maybe Text) Source #

The manifest media type of the image.

image_imageId :: Lens' Image (Maybe ImageIdentifier) Source #

An object containing the image tag and image digest associated with an image.

image_repositoryName :: Lens' Image (Maybe Text) Source #

The name of the repository associated with the image.

image_imageManifest :: Lens' Image (Maybe Text) Source #

The image manifest associated with the image.

ImageDetail

imageDetail_registryId :: Lens' ImageDetail (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry to which this image belongs.

imageDetail_imageTags :: Lens' ImageDetail (Maybe [Text]) Source #

The list of tags associated with this image.

imageDetail_imageManifestMediaType :: Lens' ImageDetail (Maybe Text) Source #

The media type of the image manifest.

imageDetail_imageSizeInBytes :: Lens' ImageDetail (Maybe Integer) Source #

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.

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 may return a larger image size than the image sizes returned by DescribeImages.

imageDetail_imageDigest :: Lens' ImageDetail (Maybe Text) Source #

The sha256 digest of the image manifest.

imageDetail_artifactMediaType :: Lens' ImageDetail (Maybe Text) Source #

The artifact media type of the image.

imageDetail_imagePushedAt :: Lens' ImageDetail (Maybe UTCTime) Source #

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

imageDetail_repositoryName :: Lens' ImageDetail (Maybe Text) Source #

The name of the repository to which this image belongs.

ImageFailure

imageFailure_failureCode :: Lens' ImageFailure (Maybe ImageFailureCode) Source #

The code associated with the failure.

imageFailure_imageId :: Lens' ImageFailure (Maybe ImageIdentifier) Source #

The image ID associated with the failure.

ImageIdentifier

imageIdentifier_imageDigest :: Lens' ImageIdentifier (Maybe Text) Source #

The sha256 digest of the image manifest.

ImageReplicationStatus

imageReplicationStatus_failureCode :: Lens' ImageReplicationStatus (Maybe Text) Source #

The failure code for a replication that has failed.

imageReplicationStatus_registryId :: Lens' ImageReplicationStatus (Maybe Text) Source #

The AWS account ID associated with the registry to which the image belongs.

imageReplicationStatus_region :: Lens' ImageReplicationStatus (Maybe Text) Source #

The destination Region for the image replication.

ImageScanFinding

imageScanFinding_uri :: Lens' ImageScanFinding (Maybe Text) Source #

A link containing additional details about the security vulnerability.

imageScanFinding_name :: Lens' ImageScanFinding (Maybe Text) Source #

The name associated with the finding, usually a CVE number.

imageScanFinding_attributes :: Lens' ImageScanFinding (Maybe [Attribute]) Source #

A collection of attributes of the host from which the finding is generated.

ImageScanFindings

imageScanFindings_imageScanCompletedAt :: Lens' ImageScanFindings (Maybe UTCTime) Source #

The time of the last completed image scan.

imageScanFindings_vulnerabilitySourceUpdatedAt :: Lens' ImageScanFindings (Maybe UTCTime) Source #

The time when the vulnerability data was last scanned.

ImageScanFindingsSummary

ImageScanStatus

imageScanStatus_status :: Lens' ImageScanStatus (Maybe ScanStatus) Source #

The current state of an image scan.

imageScanStatus_description :: Lens' ImageScanStatus (Maybe Text) Source #

The description of the image scan status.

ImageScanningConfiguration

imageScanningConfiguration_scanOnPush :: Lens' ImageScanningConfiguration (Maybe Bool) Source #

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.

Layer

layer_mediaType :: Lens' Layer (Maybe Text) Source #

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_layerDigest :: Lens' Layer (Maybe Text) Source #

The sha256 digest of the image layer.

layer_layerSize :: Lens' Layer (Maybe Integer) Source #

The size, in bytes, of the image layer.

layer_layerAvailability :: Lens' Layer (Maybe LayerAvailability) Source #

The availability status of the image layer.

LayerFailure

layerFailure_failureCode :: Lens' LayerFailure (Maybe LayerFailureCode) Source #

The failure code associated with the failure.

layerFailure_layerDigest :: Lens' LayerFailure (Maybe Text) Source #

The layer digest associated with the failure.

LifecyclePolicyPreviewFilter

LifecyclePolicyPreviewResult

lifecyclePolicyPreviewResult_imagePushedAt :: Lens' LifecyclePolicyPreviewResult (Maybe UTCTime) Source #

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

LifecyclePolicyPreviewSummary

LifecyclePolicyRuleAction

ListImagesFilter

listImagesFilter_tagStatus :: Lens' ListImagesFilter (Maybe TagStatus) Source #

The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

ReplicationConfiguration

replicationConfiguration_rules :: Lens' ReplicationConfiguration [ReplicationRule] Source #

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

ReplicationDestination

replicationDestination_registryId :: Lens' ReplicationDestination Text Source #

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.

ReplicationRule

replicationRule_repositoryFilters :: Lens' ReplicationRule (Maybe (NonEmpty RepositoryFilter)) Source #

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.

replicationRule_destinations :: Lens' ReplicationRule [ReplicationDestination] Source #

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

Repository

repository_repositoryArn :: Lens' Repository (Maybe Text) Source #

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.

repository_createdAt :: Lens' Repository (Maybe UTCTime) Source #

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

repository_registryId :: Lens' Repository (Maybe Text) Source #

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

repository_repositoryUri :: Lens' Repository (Maybe Text) Source #

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

repository_encryptionConfiguration :: Lens' Repository (Maybe EncryptionConfiguration) Source #

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

repository_repositoryName :: Lens' Repository (Maybe Text) Source #

The name of the repository.

repository_imageTagMutability :: Lens' Repository (Maybe ImageTagMutability) Source #

The tag mutability setting for the repository.

RepositoryFilter

repositoryFilter_filter :: Lens' RepositoryFilter Text Source #

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.

repositoryFilter_filterType :: Lens' RepositoryFilter RepositoryFilterType Source #

The repository filter type. The only supported value is PREFIX_MATCH, which is a repository name prefix specified with the filter parameter.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

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

tag_key :: Lens' Tag (Maybe Text) Source #

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.