String authorizationToken
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.
Date expiresAt
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
String proxyEndpoint
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..
String registryId
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.
String repositoryName
The name of the repository that is associated with the image layers to check.
List<E> layerDigests
The digests of the image layers to check.
String registryId
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.
String repositoryName
The repository that contains the image to delete.
List<E> imageIds
A list of image ID references that correspond to images to delete. The format of the imageIds
reference is imageTag=tag or imageDigest=digest.
String registryId
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.
String repositoryName
The repository that contains the images to describe.
List<E> imageIds
A list of image ID references that correspond to images to describe. The format of the imageIds
reference is imageTag=tag or imageDigest=digest.
List<E> acceptedMediaTypes
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
String registryId
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.
String repositoryName
The name of the repository to associate with the image layer.
String uploadId
The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
List<E> layerDigests
The sha256 digest of the image layer.
String registryId
The AWS account ID associated with the registry to create the repository. If you do not specify a registry, the default registry is assumed.
String repositoryName
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).
List<E> tags
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.
String imageTagMutability
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.
ImageScanningConfiguration imageScanningConfiguration
The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
EncryptionConfiguration encryptionConfiguration
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
Repository repository
The repository that was created.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String lifecyclePolicyText
The JSON lifecycle policy text.
Date lastEvaluatedAt
The time stamp of the last time that the lifecycle policy was run.
String registryId
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.
String repositoryName
The name of the repository that is associated with the repository policy to delete.
String registryId
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.
String repositoryName
The name of the repository to delete.
Boolean force
If a repository contains images, forces the deletion.
Repository repository
The repository that was deleted.
String repositoryName
The name of the repository that the image is in.
ImageIdentifier imageId
String registryId
The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.
String repositoryName
The repository name associated with the request.
ImageIdentifier imageId
List<E> replicationStatuses
The replication status details for the images in the specified repository.
String registryId
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.
String repositoryName
The repository for the image for which to describe the scan findings.
ImageIdentifier imageId
String nextToken
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.
Integer maxResults
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.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
ImageIdentifier imageId
ImageScanStatus imageScanStatus
The current state of the scan.
ImageScanFindings imageScanFindings
The information contained in the image scan findings.
String nextToken
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.
String tagStatus
The tag status with which to filter your DescribeImages results. You can filter results based on whether
they are TAGGED or UNTAGGED.
String registryId
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.
String repositoryName
The repository that contains the images to describe.
List<E> imageIds
The list of image IDs for the requested repository.
String nextToken
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.
Integer maxResults
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.
DescribeImagesFilter filter
The filter key and value with which to filter your DescribeImages results.
List<E> imageDetails
A list of ImageDetail objects that contain data about the image.
String nextToken
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.
String registryId
The ID of the registry.
ReplicationConfiguration replicationConfiguration
The replication configuration for the registry.
String registryId
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.
List<E> repositoryNames
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
String nextToken
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.
Integer maxResults
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.
List<E> repositories
A list of repository objects corresponding to valid repositories.
String nextToken
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.
String encryptionType
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..
String kmsKey
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.
String registryId
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.
String repositoryName
The name of the repository that is associated with the image layer to download.
String layerDigest
The digest of the image layer to download.
String registryId
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.
String repositoryName
The name of the repository.
List<E> imageIds
The list of imageIDs to be included.
String nextToken
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.
Integer maxResults
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.
LifecyclePolicyPreviewFilter filter
An optional parameter that filters results based on image tag status and all tags, if tagged.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String lifecyclePolicyText
The JSON lifecycle policy text.
String status
The status of the lifecycle policy preview request.
String nextToken
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.
List<E> previewResults
The results of the lifecycle policy preview request.
LifecyclePolicyPreviewSummary summary
The list of images that is returned as a result of the action.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String lifecyclePolicyText
The JSON lifecycle policy text.
Date lastEvaluatedAt
The time stamp of the last time that the lifecycle policy was run.
String registryId
The Amazon Web Services account ID associated with the registry containing the image.
String repositoryName
The name of the repository associated with the image.
ImageIdentifier imageId
An object containing the image tag and image digest associated with an image.
String imageManifest
The image manifest associated with the image.
String imageManifestMediaType
The manifest media type of the image.
String registryId
The Amazon Web Services account ID associated with the registry to which this image belongs.
String repositoryName
The name of the repository to which this image belongs.
String imageDigest
The sha256 digest of the image manifest.
List<E> imageTags
The list of tags associated with this image.
Long imageSizeInBytes
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.
Date imagePushedAt
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
ImageScanStatus imageScanStatus
The current state of the scan.
ImageScanFindingsSummary imageScanFindingsSummary
A summary of the last completed image scan.
String imageManifestMediaType
The media type of the image manifest.
String artifactMediaType
The artifact media type of the image.
ImageIdentifier imageId
The image ID associated with the failure.
String failureCode
The code associated with the failure.
String failureReason
The reason for the failure.
String region
The destination Region for the image replication.
String registryId
The AWS account ID associated with the registry to which the image belongs.
String status
The image replication status.
String failureCode
The failure code for a replication that has failed.
String name
The name associated with the finding, usually a CVE number.
String description
The description of the finding.
String uri
A link containing additional details about the security vulnerability.
String severity
The finding severity.
List<E> attributes
A collection of attributes of the host from which the finding is generated.
Date imageScanCompletedAt
The time of the last completed image scan.
Date vulnerabilitySourceUpdatedAt
The time when the vulnerability data was last scanned.
List<E> findings
The findings from the image scan.
Map<K,V> findingSeverityCounts
The image vulnerability counts, sorted by severity.
Date imageScanCompletedAt
The time of the last completed image scan.
Date vulnerabilitySourceUpdatedAt
The time when the vulnerability data was last scanned.
Map<K,V> findingSeverityCounts
The image vulnerability counts, sorted by severity.
Boolean scanOnPush
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.
String uploadId
The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
Long partSize
The size, in bytes, that Amazon ECR expects future layer part uploads to be.
String registryId
The registry ID associated with the exception.
String repositoryName
The repository name associated with the exception.
String uploadId
The upload ID associated with the exception.
Long lastValidByteReceived
The last valid byte received from the layer part upload that is associated with the exception.
String kmsError
The error code returned by KMS.
String layerDigest
The sha256 digest of the image layer.
String layerAvailability
The availability status of the image layer.
Long layerSize
The size, in bytes, of the image layer.
String mediaType
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.
String tagStatus
The tag status of the image.
List<E> imageTags
The list of tags associated with this image.
String imageDigest
The sha256 digest of the image manifest.
Date imagePushedAt
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
LifecyclePolicyRuleAction action
The type of action to be taken.
Integer appliedRulePriority
The priority of the applied rule.
Integer expiringImageTotalCount
The number of expiring images.
String type
The type of action to be taken.
String tagStatus
The tag status with which to filter your ListImages results. You can filter results based on whether they
are TAGGED or UNTAGGED.
String registryId
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.
String repositoryName
The repository with image IDs to be listed.
String nextToken
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.
Integer maxResults
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.
ListImagesFilter filter
The filter key and value with which to filter your ListImages results.
List<E> imageIds
The list of image IDs for the requested repository.
String nextToken
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.
String resourceArn
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.
String registryId
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.
String repositoryName
The name of the repository in which to put the image.
String imageManifest
The image manifest corresponding to the image to be uploaded.
String imageManifestMediaType
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.
String imageTag
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.
String imageDigest
The image digest of the image manifest corresponding to the image.
Image image
Details of the image uploaded.
String registryId
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.
String repositoryName
The name of the repository in which to update the image scanning configuration setting.
ImageScanningConfiguration imageScanningConfiguration
The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
ImageScanningConfiguration imageScanningConfiguration
The image scanning configuration setting for the repository.
String registryId
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.
String repositoryName
The name of the repository in which to update the image tag mutability settings.
String imageTagMutability
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.
String registryId
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.
String repositoryName
The name of the repository to receive the policy.
String lifecyclePolicyText
The JSON repository policy text to apply to the repository.
String policyText
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.
ReplicationConfiguration replicationConfiguration
An object representing the replication configuration for a registry.
ReplicationConfiguration replicationConfiguration
The contents of the replication configuration for the registry.
List<E> destinations
An array of objects representing the destination for a replication rule.
List<E> repositoryFilters
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.
String repositoryArn
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.
String registryId
The Amazon Web Services account ID associated with the registry that contains the repository.
String repositoryName
The name of the repository.
String repositoryUri
The URI for the repository. You can use this URI for container image push and pull
operations.
Date createdAt
The date and time, in JavaScript date format, when the repository was created.
String imageTagMutability
The tag mutability setting for the repository.
ImageScanningConfiguration imageScanningConfiguration
EncryptionConfiguration encryptionConfiguration
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
String filter
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.
String filterType
The repository filter type. The only supported value is PREFIX_MATCH, which is a repository name
prefix specified with the filter parameter.
String registryId
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.
String repositoryName
The name of the repository to receive the policy.
String policyText
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.
Boolean force
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.
String registryId
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.
String repositoryName
The name of the repository that contains the images to scan.
ImageIdentifier imageId
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
ImageIdentifier imageId
ImageScanStatus imageScanStatus
The current state of the scan.
String registryId
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.
String repositoryName
The name of the repository to be evaluated.
String lifecyclePolicyText
The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String lifecyclePolicyText
The JSON repository policy text.
String status
The status of the lifecycle policy preview request.
String resourceArn
The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
List<E> tags
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.
String registryId
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.
String repositoryName
The name of the repository to which you are uploading layer parts.
String uploadId
The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
Long partFirstByte
The position of the first byte of the layer part witin the overall image layer.
Long partLastByte
The position of the last byte of the layer part within the overall image layer.
ByteBuffer layerPartBlob
The base64-encoded layer part payload.
String registryId
The registry ID associated with the request.
String repositoryName
The repository name associated with the request.
String uploadId
The upload ID associated with the request.
Long lastByteReceived
The integer value of the last byte received in the request.
Copyright © 2021. All rights reserved.