String authorizationToken
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.
Date expiresAt
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
String registryId
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.
String repositoryName
The name of the repository that's 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 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.
String repositoryName
The repository in a public registry 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, or registry alias, associated with the registry where layers are uploaded. If you do not specify a registry, the default public registry is assumed.
String repositoryName
The name of the repository in a public registry 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 public registry ID that's associated with the request.
String repositoryName
The repository name that's associated with the request.
String uploadId
The upload ID that's associated with the layer.
String layerDigest
The sha256 digest of the image layer.
String repositoryName
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).
RepositoryCatalogDataInput catalogData
The details about the repository that are publicly visible in the Amazon ECR Public Gallery.
List<E> tags
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.
Repository repository
The repository that was created.
RepositoryCatalogData catalogData
String registryId
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.
String repositoryName
The name of the repository that's associated with the repository policy to delete.
String registryId
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.
String repositoryName
The name of the repository to delete.
Boolean force
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.
Repository repository
The repository that was deleted.
String registryId
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.
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 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.
Integer maxResults
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.
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, you can use this value to retrieve the next
page of results. If there are no more results to return, this value is null.
String registryId
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.
String repositoryName
The name of the repository that contains the image tag details to describe.
String nextToken
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.
Integer maxResults
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.
List<E> imageTagDetails
The image tag details for the images in the requested repository.
String nextToken
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.
String nextToken
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.
Integer maxResults
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.
List<E> registries
An object that contains the details for a public registry.
String nextToken
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.
String registryId
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.
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 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.
Integer maxResults
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.
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. If there are no more results to return, this value is null.
AuthorizationData authorizationData
An authorization token data object that corresponds to a public registry.
RegistryCatalogData registryCatalogData
The catalog metadata for the public registry.
String registryId
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.
String repositoryName
The name of the repository to retrieve the catalog metadata for.
RepositoryCatalogData catalogData
The catalog metadata for the repository.
String registryId
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.
String repositoryName
The name of the repository with the policy to retrieve.
String registryId
The registry ID that's associated with the request.
String repositoryName
The repository name that's associated with the request.
String policyText
The repository policy text that's associated with the repository. The policy text will be in JSON format.
String registryId
The Amazon Web Services account ID that's associated with the registry containing the image.
String repositoryName
The name of the repository that's associated with the image.
ImageIdentifier imageId
An object that contains the image tag and image digest associated with an image.
String imageManifest
The image manifest that's associated with the image.
String imageManifestMediaType
The manifest media type of the image.
String registryId
The Amazon Web Services account ID that's associated with the public registry where this image belongs.
String repositoryName
The name of the repository where this image belongs.
String imageDigest
The sha256 digest of the image manifest.
List<E> imageTags
The list of tags that's associated with this image.
Long imageSizeInBytes
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.
Date imagePushedAt
The date and time, expressed in standard JavaScript date format, that the current image was pushed to the repository at.
String imageManifestMediaType
The media type of the image manifest.
String artifactMediaType
The artifact media type of the image.
ImageIdentifier imageId
The image ID that's associated with the failure.
String failureCode
The code that's associated with the failure.
String failureReason
The reason for the failure.
String imageTag
The tag that's associated with the image.
Date createdAt
The time stamp that indicates when the image tag was created.
ReferencedImageDetail imageDetail
An object that describes the details of an image.
String registryId
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.
String repositoryName
The name of the repository that you want to upload layers to.
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 Amazon Web Services account ID that's associated with the layer part.
String repositoryName
The name of the repository.
String uploadId
The upload ID that's associated with the layer part.
Long lastValidByteReceived
The position of the last byte of the layer part.
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 resourceArn
The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resource is an Amazon ECR Public repository.
String registryId
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.
String repositoryName
The name of the repository where the image is put.
String imageManifest
The image manifest that corresponds to the image to be uploaded.
String imageManifestMediaType
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.
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 that corresponds to the image.
Image image
Details of the image uploaded.
String displayName
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.
RegistryCatalogData registryCatalogData
The catalog data for the public registry.
String registryId
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.
String repositoryName
The name of the repository to create or update the catalog data for.
RepositoryCatalogDataInput catalogData
An object containing the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
RepositoryCatalogData catalogData
The catalog data for the repository.
String imageDigest
The sha256 digest of the image manifest.
Long imageSizeInBytes
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.
Date imagePushedAt
The date and time, expressed in standard JavaScript date format, which the current image tag was pushed to the repository at.
String imageManifestMediaType
The media type of the image manifest.
String artifactMediaType
The artifact media type of the image.
String registryId
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.
String registryArn
The Amazon Resource Name (ARN) of the public registry.
String registryUri
The URI of a public registry. The URI contains a universal prefix and the registry alias.
Boolean 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.
List<E> aliases
An array of objects that represents the aliases for a public registry.
String name
The name of the registry alias.
String status
The status of the registry alias.
Boolean primaryRegistryAlias
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.
Boolean defaultRegistryAlias
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.
String displayName
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.
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 that's associated with the public 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 description
The short description of the repository.
List<E> architectures
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.
List<E> operatingSystems
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.
String logoUrl
The URL that contains the logo that's associated with the repository.
String aboutText
The longform description of the contents of the repository. This text appears in the repository details on the Amazon ECR Public Gallery.
String usageText
The longform usage details of the contents of the repository. The usage text provides context for users of the repository.
Boolean marketplaceCertified
Indicates whether the repository is certified by Amazon Web Services Marketplace.
String description
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.
List<E> architectures
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
List<E> operatingSystems
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
ByteBuffer logoImageBlob
The base64-encoded repository logo payload.
The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.
String aboutText
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.
String usageText
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.
String registryId
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.
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 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.
String resourceArn
The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resource is an Amazon ECR Public 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, 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.
String repositoryName
The name of the repository that you're uploading layer parts to.
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 that's associated with the request.
String repositoryName
The repository name that's associated with the request.
String uploadId
The upload ID that's associated with the request.
Long lastByteReceived
The integer value of the last byte that's received in the request.
Copyright © 2023. All rights reserved.