Table of Contents
ECR.
Client
¶A low-level client representing Amazon EC2 Container Registry (ECR)
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.
client = session.create_client('ecr')
These are the available methods:
batch_check_layer_availability
(**kwargs)¶Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.batch_check_layer_availability(
registryId='string',
repositoryName='string',
layerDigests=[
'string',
]
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository that is associated with the image layers to check.
layerDigests (list) –
[REQUIRED]
The digests of the image layers to check.
(string) –
dict
Response Syntax
{
'layers': [
{
'layerDigest': 'string',
'layerAvailability': 'AVAILABLE'|'UNAVAILABLE',
'layerSize': 123,
'mediaType': 'string'
},
],
'failures': [
{
'layerDigest': 'string',
'failureCode': 'InvalidLayerDigest'|'MissingLayerDigest',
'failureReason': 'string'
},
]
}
Response Structure
(dict) –
layers (list) –
A list of image layer objects corresponding to the image layer references in the request.
(dict) –
An object representing an Amazon ECR image layer.
layerDigest (string) –
The sha256
digest of the image layer.
layerAvailability (string) –
The availability status of the image layer.
layerSize (integer) –
The size, in bytes, of the image layer.
mediaType (string) –
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
.
failures (list) –
Any failures associated with the call.
(dict) –
An object representing an Amazon ECR image layer failure.
layerDigest (string) –
The layer digest associated with the failure.
failureCode (string) –
The failure code associated with the failure.
failureReason (string) –
The reason for the failure.
Exceptions
batch_delete_image
(**kwargs)¶Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest
.
You can remove a tag from an image by specifying the image’s tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image’s digest in your request.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_image(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
]
)
registryId (string) – The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The repository that contains the image to delete.
imageIds (list) –
[REQUIRED]
A list of image ID references that correspond to images to delete. The format of the imageIds
reference is imageTag=tag
or imageDigest=digest
.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
dict
Response Syntax
{
'imageIds': [
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
'failures': [
{
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'failureCode': 'InvalidImageDigest'|'InvalidImageTag'|'ImageTagDoesNotMatchDigest'|'ImageNotFound'|'MissingDigestAndTag'|'ImageReferencedByManifestList'|'KmsError',
'failureReason': 'string'
},
]
}
Response Structure
(dict) –
imageIds (list) –
The image IDs of the deleted images.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
failures (list) –
Any failures associated with the call.
(dict) –
An object representing an Amazon ECR image failure.
imageId (dict) –
The image ID associated with the failure.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
failureCode (string) –
The code associated with the failure.
failureReason (string) –
The reason for the failure.
Exceptions
Examples
This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.
response = client.batch_delete_image(
imageIds=[
{
'imageTag': 'precise',
},
],
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'failures': [
],
'imageIds': [
{
'imageDigest': 'sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f',
'imageTag': 'precise',
},
],
'ResponseMetadata': {
'...': '...',
},
}
batch_get_image
(**kwargs)¶Gets detailed information for an image. Images are specified with either an imageTag
or imageDigest
.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
See also: AWS API Documentation
Request Syntax
response = client.batch_get_image(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
acceptedMediaTypes=[
'string',
]
)
registryId (string) – The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The repository that contains the images to describe.
imageIds (list) –
[REQUIRED]
A list of image ID references that correspond to images to describe. The format of the imageIds
reference is imageTag=tag
or imageDigest=digest
.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
acceptedMediaTypes (list) –
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) –
dict
Response Syntax
{
'images': [
{
'registryId': 'string',
'repositoryName': 'string',
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'imageManifest': 'string',
'imageManifestMediaType': 'string'
},
],
'failures': [
{
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'failureCode': 'InvalidImageDigest'|'InvalidImageTag'|'ImageTagDoesNotMatchDigest'|'ImageNotFound'|'MissingDigestAndTag'|'ImageReferencedByManifestList'|'KmsError',
'failureReason': 'string'
},
]
}
Response Structure
(dict) –
images (list) –
A list of image objects corresponding to the image references in the request.
(dict) –
An object representing an Amazon ECR image.
registryId (string) –
The AWS account ID associated with the registry containing the image.
repositoryName (string) –
The name of the repository associated with the image.
imageId (dict) –
An object containing the image tag and image digest associated with an image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
imageManifest (string) –
The image manifest associated with the image.
imageManifestMediaType (string) –
The manifest media type of the image.
failures (list) –
Any failures associated with the call.
(dict) –
An object representing an Amazon ECR image failure.
imageId (dict) –
The image ID associated with the failure.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
failureCode (string) –
The code associated with the failure.
failureReason (string) –
The reason for the failure.
Exceptions
Examples
This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.
response = client.batch_get_image(
imageIds=[
{
'imageTag': 'precise',
},
],
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'failures': [
],
'images': [
{
'imageId': {
'imageDigest': 'sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a',
'imageTag': 'precise',
},
'imageManifest': '{\n "schemaVersion": 1,\n "name": "ubuntu",\n "tag": "precise",\n...',
'registryId': '244698725403',
'repositoryName': 'ubuntu',
},
],
'ResponseMetadata': {
'...': '...',
},
}
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
True
if the operation can be paginated,
False
otherwise.
complete_layer_upload
(**kwargs)¶Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256
digest of the image layer for data validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.complete_layer_upload(
registryId='string',
repositoryName='string',
uploadId='string',
layerDigests=[
'string',
]
)
registryId (string) – The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to associate with the image layer.
uploadId (string) –
[REQUIRED]
The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
layerDigests (list) –
[REQUIRED]
The sha256
digest of the image layer.
(string) –
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'uploadId': 'string',
'layerDigest': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
uploadId (string) –
The upload ID associated with the layer.
layerDigest (string) –
The sha256
digest of the image layer.
Exceptions
create_repository
(**kwargs)¶Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_repository(
repositoryName='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
imageTagMutability='MUTABLE'|'IMMUTABLE',
imageScanningConfiguration={
'scanOnPush': True|False
},
encryptionConfiguration={
'encryptionType': 'AES256'|'KMS',
'kmsKey': 'string'
}
)
repositoryName (string) –
[REQUIRED]
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
).
tags (list) –
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.
(dict) –
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, 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.
Key (string) –
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.
Value (string) –
The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
imageTagMutability (string) – 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 (dict) –
The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.
scanOnPush (boolean) –
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 StartImageScan API.
encryptionConfiguration (dict) –
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
encryptionType (string) – [REQUIRED]
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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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. .
kmsKey (string) –
If you use the KMS
encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
dict
Response Syntax
{
'repository': {
'repositoryArn': 'string',
'registryId': 'string',
'repositoryName': 'string',
'repositoryUri': 'string',
'createdAt': datetime(2015, 1, 1),
'imageTagMutability': 'MUTABLE'|'IMMUTABLE',
'imageScanningConfiguration': {
'scanOnPush': True|False
},
'encryptionConfiguration': {
'encryptionType': 'AES256'|'KMS',
'kmsKey': 'string'
}
}
}
Response Structure
(dict) –
repository (dict) –
The repository that was created.
repositoryArn (string) –
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr
namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test
.
registryId (string) –
The AWS account ID associated with the registry that contains the repository.
repositoryName (string) –
The name of the repository.
repositoryUri (string) –
The URI for the repository. You can use this URI for container image push
and pull
operations.
createdAt (datetime) –
The date and time, in JavaScript date format, when the repository was created.
imageTagMutability (string) –
The tag mutability setting for the repository.
imageScanningConfiguration (dict) –
The image scanning configuration for a repository.
scanOnPush (boolean) –
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 StartImageScan API.
encryptionConfiguration (dict) –
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
encryptionType (string) –
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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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. .
kmsKey (string) –
If you use the KMS
encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
Exceptions
Examples
This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.
response = client.create_repository(
repositoryName='project-a/nginx-web-app',
)
print(response)
Expected Output:
{
'repository': {
'registryId': '012345678901',
'repositoryArn': 'arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app',
'repositoryName': 'project-a/nginx-web-app',
},
'ResponseMetadata': {
'...': '...',
},
}
delete_lifecycle_policy
(**kwargs)¶Deletes the lifecycle policy associated with the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.delete_lifecycle_policy(
registryId='string',
repositoryName='string'
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string',
'lastEvaluatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON lifecycle policy text.
lastEvaluatedAt (datetime) –
The time stamp of the last time that the lifecycle policy was run.
Exceptions
delete_registry_policy
()¶Deletes the registry permissions policy.
See also: AWS API Documentation
Request Syntax
response = client.delete_registry_policy()
dict
Response Syntax
{
'registryId': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
policyText (string) –
The contents of the registry permissions policy that was deleted.
Exceptions
delete_repository
(**kwargs)¶Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force
option to delete the repository.
See also: AWS API Documentation
Request Syntax
response = client.delete_repository(
registryId='string',
repositoryName='string',
force=True|False
)
registryId (string) – The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to delete.
force (boolean) – If a repository contains images, forces the deletion.
dict
Response Syntax
{
'repository': {
'repositoryArn': 'string',
'registryId': 'string',
'repositoryName': 'string',
'repositoryUri': 'string',
'createdAt': datetime(2015, 1, 1),
'imageTagMutability': 'MUTABLE'|'IMMUTABLE',
'imageScanningConfiguration': {
'scanOnPush': True|False
},
'encryptionConfiguration': {
'encryptionType': 'AES256'|'KMS',
'kmsKey': 'string'
}
}
}
Response Structure
(dict) –
repository (dict) –
The repository that was deleted.
repositoryArn (string) –
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr
namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test
.
registryId (string) –
The AWS account ID associated with the registry that contains the repository.
repositoryName (string) –
The name of the repository.
repositoryUri (string) –
The URI for the repository. You can use this URI for container image push
and pull
operations.
createdAt (datetime) –
The date and time, in JavaScript date format, when the repository was created.
imageTagMutability (string) –
The tag mutability setting for the repository.
imageScanningConfiguration (dict) –
The image scanning configuration for a repository.
scanOnPush (boolean) –
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 StartImageScan API.
encryptionConfiguration (dict) –
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
encryptionType (string) –
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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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. .
kmsKey (string) –
If you use the KMS
encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
Exceptions
Examples
This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.
response = client.delete_repository(
force=True,
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'repository': {
'registryId': '012345678901',
'repositoryArn': 'arn:aws:ecr:us-west-2:012345678901:repository/ubuntu',
'repositoryName': 'ubuntu',
},
'ResponseMetadata': {
'...': '...',
},
}
delete_repository_policy
(**kwargs)¶Deletes the repository policy associated with the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.delete_repository_policy(
registryId='string',
repositoryName='string'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository that is associated with the repository policy to delete.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
policyText (string) –
The JSON repository policy that was deleted from the repository.
Exceptions
Examples
This example deletes the policy associated with the repository named ubuntu in the current account.
response = client.delete_repository_policy(
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'policyText': '{ ... }',
'registryId': '012345678901',
'repositoryName': 'ubuntu',
'ResponseMetadata': {
'...': '...',
},
}
describe_image_scan_findings
(**kwargs)¶Returns the scan findings for the specified image.
See also: AWS API Documentation
Request Syntax
response = client.describe_image_scan_findings(
registryId='string',
repositoryName='string',
imageId={
'imageDigest': 'string',
'imageTag': 'string'
},
nextToken='string',
maxResults=123
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository for the image for which to describe the scan findings.
imageId (dict) –
[REQUIRED]
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) – 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.
maxResults (integer) – 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.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'imageScanStatus': {
'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'description': 'string'
},
'imageScanFindings': {
'imageScanCompletedAt': datetime(2015, 1, 1),
'vulnerabilitySourceUpdatedAt': datetime(2015, 1, 1),
'findings': [
{
'name': 'string',
'description': 'string',
'uri': 'string',
'severity': 'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'|'UNDEFINED',
'attributes': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'findingSeverityCounts': {
'string': 123
}
},
'nextToken': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
imageId (dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
imageScanStatus (dict) –
The current state of the scan.
status (string) –
The current state of an image scan.
description (string) –
The description of the image scan status.
imageScanFindings (dict) –
The information contained in the image scan findings.
imageScanCompletedAt (datetime) –
The time of the last completed image scan.
vulnerabilitySourceUpdatedAt (datetime) –
The time when the vulnerability data was last scanned.
findings (list) –
The findings from the image scan.
(dict) –
Contains information about an image scan finding.
name (string) –
The name associated with the finding, usually a CVE number.
description (string) –
The description of the finding.
uri (string) –
A link containing additional details about the security vulnerability.
severity (string) –
The finding severity.
attributes (list) –
A collection of attributes of the host from which the finding is generated.
(dict) –
This data type is used in the ImageScanFinding data type.
key (string) –
The attribute key.
value (string) –
The value assigned to the attribute key.
findingSeverityCounts (dict) –
The image vulnerability counts, sorted by severity.
(string) –
(integer) –
nextToken (string) –
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.
Exceptions
describe_images
(**kwargs)¶Returns metadata about the images in a repository.
Note
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 .
See also: AWS API Documentation
Request Syntax
response = client.describe_images(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
nextToken='string',
maxResults=123,
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository that contains the images to describe.
imageIds (list) –
The list of image IDs for the requested repository.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) – 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
.
maxResults (integer) – 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
.
filter (dict) –
The filter key and value with which to filter your DescribeImages
results.
tagStatus (string) –
The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
dict
Response Syntax
{
'imageDetails': [
{
'registryId': 'string',
'repositoryName': 'string',
'imageDigest': 'string',
'imageTags': [
'string',
],
'imageSizeInBytes': 123,
'imagePushedAt': datetime(2015, 1, 1),
'imageScanStatus': {
'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'description': 'string'
},
'imageScanFindingsSummary': {
'imageScanCompletedAt': datetime(2015, 1, 1),
'vulnerabilitySourceUpdatedAt': datetime(2015, 1, 1),
'findingSeverityCounts': {
'string': 123
}
},
'imageManifestMediaType': 'string',
'artifactMediaType': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
imageDetails (list) –
A list of ImageDetail objects that contain data about the image.
(dict) –
An object that describes an image returned by a DescribeImages operation.
registryId (string) –
The AWS account ID associated with the registry to which this image belongs.
repositoryName (string) –
The name of the repository to which this image belongs.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTags (list) –
The list of tags associated with this image.
(string) –
imageSizeInBytes (integer) –
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.
Note
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 .
imagePushedAt (datetime) –
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
imageScanStatus (dict) –
The current state of the scan.
status (string) –
The current state of an image scan.
description (string) –
The description of the image scan status.
imageScanFindingsSummary (dict) –
A summary of the last completed image scan.
imageScanCompletedAt (datetime) –
The time of the last completed image scan.
vulnerabilitySourceUpdatedAt (datetime) –
The time when the vulnerability data was last scanned.
findingSeverityCounts (dict) –
The image vulnerability counts, sorted by severity.
(string) –
(integer) –
imageManifestMediaType (string) –
The media type of the image manifest.
artifactMediaType (string) –
The artifact media type of the image.
nextToken (string) –
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.
Exceptions
describe_registry
()¶Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
See also: AWS API Documentation
Request Syntax
response = client.describe_registry()
dict
Response Syntax
{
'registryId': 'string',
'replicationConfiguration': {
'rules': [
{
'destinations': [
{
'region': 'string',
'registryId': 'string'
},
]
},
]
}
}
Response Structure
(dict) –
registryId (string) –
The ID of the registry.
replicationConfiguration (dict) –
The replication configuration for the registry.
rules (list) –
An array of objects representing the replication rules for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
(dict) –
An array of objects representing the replication destinations for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
destinations (list) –
An array of objects representing the details of a replication destination.
(dict) –
An array of objects representing the details of a replication destination.
region (string) –
A Region to replicate to.
registryId (string) –
The account ID of the destination registry to replicate to.
Exceptions
describe_repositories
(**kwargs)¶Describes image repositories in a registry.
See also: AWS API Documentation
Request Syntax
response = client.describe_repositories(
registryId='string',
repositoryNames=[
'string',
],
nextToken='string',
maxResults=123
)
registryId (string) – The AWS 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.
repositoryNames (list) –
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
(string) –
nextToken (string) –
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
.
Note
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.
maxResults (integer) – 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
.
dict
Response Syntax
{
'repositories': [
{
'repositoryArn': 'string',
'registryId': 'string',
'repositoryName': 'string',
'repositoryUri': 'string',
'createdAt': datetime(2015, 1, 1),
'imageTagMutability': 'MUTABLE'|'IMMUTABLE',
'imageScanningConfiguration': {
'scanOnPush': True|False
},
'encryptionConfiguration': {
'encryptionType': 'AES256'|'KMS',
'kmsKey': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
repositories (list) –
A list of repository objects corresponding to valid repositories.
(dict) –
An object representing a repository.
repositoryArn (string) –
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr
namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test
.
registryId (string) –
The AWS account ID associated with the registry that contains the repository.
repositoryName (string) –
The name of the repository.
repositoryUri (string) –
The URI for the repository. You can use this URI for container image push
and pull
operations.
createdAt (datetime) –
The date and time, in JavaScript date format, when the repository was created.
imageTagMutability (string) –
The tag mutability setting for the repository.
imageScanningConfiguration (dict) –
The image scanning configuration for a repository.
scanOnPush (boolean) –
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 StartImageScan API.
encryptionConfiguration (dict) –
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
encryptionType (string) –
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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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. .
kmsKey (string) –
If you use the KMS
encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
nextToken (string) –
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.
Exceptions
Examples
The following example obtains a list and description of all repositories in the default registry to which the current user has access.
response = client.describe_repositories(
)
print(response)
Expected Output:
{
'repositories': [
{
'registryId': '012345678910',
'repositoryArn': 'arn:aws:ecr:us-west-2:012345678910:repository/ubuntu',
'repositoryName': 'ubuntu',
},
{
'registryId': '012345678910',
'repositoryArn': 'arn:aws:ecr:us-west-2:012345678910:repository/test',
'repositoryName': 'test',
},
],
'ResponseMetadata': {
'...': '...',
},
}
generate_presigned_url
(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
ClientMethod (string) – The client method to presign for
Params (dict) – The parameters normally passed to
ClientMethod
.
ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
The presigned url
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken
returned is a base64 encoded string that can be decoded and used in a docker login
command to authenticate to a registry. The AWS CLI offers an get-login-password
command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_authorization_token(
registryIds=[
'string',
]
)
registryIds (list) –
A list of AWS 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.
(string) –
dict
Response Syntax
{
'authorizationData': [
{
'authorizationToken': 'string',
'expiresAt': datetime(2015, 1, 1),
'proxyEndpoint': 'string'
},
]
}
Response Structure
(dict) –
authorizationData (list) –
A list of authorization token data objects that correspond to the registryIds
values in the request.
(dict) –
An object representing authorization data for an Amazon ECR registry.
authorizationToken (string) –
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
.
expiresAt (datetime) –
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.
proxyEndpoint (string) –
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
..
Exceptions
get_download_url_for_layer
(**kwargs)¶Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.get_download_url_for_layer(
registryId='string',
repositoryName='string',
layerDigest='string'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository that is associated with the image layer to download.
layerDigest (string) –
[REQUIRED]
The digest of the image layer to download.
dict
Response Syntax
{
'downloadUrl': 'string',
'layerDigest': 'string'
}
Response Structure
(dict) –
downloadUrl (string) –
The pre-signed Amazon S3 download URL for the requested layer.
layerDigest (string) –
The digest of the image layer to download.
Exceptions
get_lifecycle_policy
(**kwargs)¶Retrieves the lifecycle policy for the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.get_lifecycle_policy(
registryId='string',
repositoryName='string'
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string',
'lastEvaluatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON lifecycle policy text.
lastEvaluatedAt (datetime) –
The time stamp of the last time that the lifecycle policy was run.
Exceptions
get_lifecycle_policy_preview
(**kwargs)¶Retrieves the results of the lifecycle policy preview request for the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.get_lifecycle_policy_preview(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
nextToken='string',
maxResults=123,
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
}
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository.
imageIds (list) –
The list of imageIDs to be included.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) – 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
.
maxResults (integer) – 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
.
filter (dict) –
An optional parameter that filters results based on image tag status and all tags, if tagged.
tagStatus (string) –
The tag status of the image.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string',
'status': 'IN_PROGRESS'|'COMPLETE'|'EXPIRED'|'FAILED',
'nextToken': 'string',
'previewResults': [
{
'imageTags': [
'string',
],
'imageDigest': 'string',
'imagePushedAt': datetime(2015, 1, 1),
'action': {
'type': 'EXPIRE'
},
'appliedRulePriority': 123
},
],
'summary': {
'expiringImageTotalCount': 123
}
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON lifecycle policy text.
status (string) –
The status of the lifecycle policy preview request.
nextToken (string) –
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.
previewResults (list) –
The results of the lifecycle policy preview request.
(dict) –
The result of the lifecycle policy preview.
imageTags (list) –
The list of tags associated with this image.
(string) –
imageDigest (string) –
The sha256
digest of the image manifest.
imagePushedAt (datetime) –
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
action (dict) –
The type of action to be taken.
type (string) –
The type of action to be taken.
appliedRulePriority (integer) –
The priority of the applied rule.
summary (dict) –
The list of images that is returned as a result of the action.
expiringImageTotalCount (integer) –
The number of expiring images.
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo
, and you’d normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_registry_policy
()¶Retrieves the permissions policy for a registry.
See also: AWS API Documentation
Request Syntax
response = client.get_registry_policy()
dict
Response Syntax
{
'registryId': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The ID of the registry.
policyText (string) –
The JSON text of the permissions policy for a registry.
Exceptions
get_repository_policy
(**kwargs)¶Retrieves the repository policy for the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.get_repository_policy(
registryId='string',
repositoryName='string'
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository with the policy to retrieve.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
policyText (string) –
The JSON repository policy text associated with the repository.
Exceptions
Examples
This example obtains the repository policy for the repository named ubuntu.
response = client.get_repository_policy(
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'policyText': '{\n "Version" : "2008-10-17",\n "Statement" : [ {\n "Sid" : "new statement",\n "Effect" : "Allow",\n "Principal" : {\n "AWS" : "arn:aws:iam::012345678901:role/CodeDeployDemo"\n },\n"Action" : [ "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage", "ecr:BatchCheckLayerAvailability" ]\n } ]\n}',
'registryId': '012345678901',
'repositoryName': 'ubuntu',
'ResponseMetadata': {
'...': '...',
},
}
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
initiate_layer_upload
(**kwargs)¶Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.initiate_layer_upload(
registryId='string',
repositoryName='string'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository to which you intend to upload layers.
dict
Response Syntax
{
'uploadId': 'string',
'partSize': 123
}
Response Structure
(dict) –
uploadId (string) –
The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.
partSize (integer) –
The size, in bytes, that Amazon ECR expects future layer part uploads to be.
Exceptions
list_images
(**kwargs)¶Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus
filter and specifying either TAGGED
, UNTAGGED
or ANY
. For example, you can filter your results to return only UNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED
images to list all of the tags in your repository.
See also: AWS API Documentation
Request Syntax
response = client.list_images(
registryId='string',
repositoryName='string',
nextToken='string',
maxResults=123,
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository with image IDs to be listed.
nextToken (string) –
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.
Note
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.
maxResults (integer) – 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.
filter (dict) –
The filter key and value with which to filter your ListImages
results.
tagStatus (string) –
The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
dict
Response Syntax
{
'imageIds': [
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) –
imageIds (list) –
The list of image IDs for the requested repository.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) –
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.
Exceptions
Examples
This example lists all of the images in the repository named ubuntu in the default registry in the current account.
response = client.list_images(
repositoryName='ubuntu',
)
print(response)
Expected Output:
{
'imageIds': [
{
'imageDigest': 'sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a',
'imageTag': 'precise',
},
],
'ResponseMetadata': {
'...': '...',
},
}
List the tags for an Amazon ECR resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
resourceArn (string) –
[REQUIRED]
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.
dict
Response Syntax
{
'tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) –
tags (list) –
The tags for the resource.
(dict) –
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, 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.
Key (string) –
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.
Value (string) –
The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
Exceptions
put_image
(**kwargs)¶Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.put_image(
registryId='string',
repositoryName='string',
imageManifest='string',
imageManifestMediaType='string',
imageTag='string',
imageDigest='string'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository in which to put the image.
imageManifest (string) –
[REQUIRED]
The image manifest corresponding to the image to be uploaded.
imageManifestMediaType (string) – 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.
imageTag (string) – 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.
imageDigest (string) – The image digest of the image manifest corresponding to the image.
dict
Response Syntax
{
'image': {
'registryId': 'string',
'repositoryName': 'string',
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'imageManifest': 'string',
'imageManifestMediaType': 'string'
}
}
Response Structure
(dict) –
image (dict) –
Details of the image uploaded.
registryId (string) –
The AWS account ID associated with the registry containing the image.
repositoryName (string) –
The name of the repository associated with the image.
imageId (dict) –
An object containing the image tag and image digest associated with an image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
imageManifest (string) –
The image manifest associated with the image.
imageManifestMediaType (string) –
The manifest media type of the image.
Exceptions
put_image_scanning_configuration
(**kwargs)¶Updates the image scanning configuration for the specified repository.
See also: AWS API Documentation
Request Syntax
response = client.put_image_scanning_configuration(
registryId='string',
repositoryName='string',
imageScanningConfiguration={
'scanOnPush': True|False
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository in which to update the image scanning configuration setting.
imageScanningConfiguration (dict) –
[REQUIRED]
The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.
scanOnPush (boolean) –
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 StartImageScan API.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'imageScanningConfiguration': {
'scanOnPush': True|False
}
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
imageScanningConfiguration (dict) –
The image scanning configuration setting for the repository.
scanOnPush (boolean) –
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 StartImageScan API.
Exceptions
put_image_tag_mutability
(**kwargs)¶Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_image_tag_mutability(
registryId='string',
repositoryName='string',
imageTagMutability='MUTABLE'|'IMMUTABLE'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository in which to update the image tag mutability settings.
imageTagMutability (string) –
[REQUIRED]
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.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'imageTagMutability': 'MUTABLE'|'IMMUTABLE'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
imageTagMutability (string) –
The image tag mutability setting for the repository.
Exceptions
put_lifecycle_policy
(**kwargs)¶Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template .
See also: AWS API Documentation
Request Syntax
response = client.put_lifecycle_policy(
registryId='string',
repositoryName='string',
lifecyclePolicyText='string'
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to receive the policy.
lifecyclePolicyText (string) –
[REQUIRED]
The JSON repository policy text to apply to the repository.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON repository policy text.
Exceptions
put_registry_policy
(**kwargs)¶Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_registry_policy(
policyText='string'
)
policyText (string) –
[REQUIRED]
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 .
dict
Response Syntax
{
'registryId': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID.
policyText (string) –
The JSON policy text for your registry.
Exceptions
put_replication_configuration
(**kwargs)¶Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR in the Amazon Elastic Container Registry User Guide .
Note
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy .
See also: AWS API Documentation
Request Syntax
response = client.put_replication_configuration(
replicationConfiguration={
'rules': [
{
'destinations': [
{
'region': 'string',
'registryId': 'string'
},
]
},
]
}
)
replicationConfiguration (dict) –
[REQUIRED]
An object representing the replication configuration for a registry.
rules (list) – [REQUIRED]
An array of objects representing the replication rules for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
(dict) –
An array of objects representing the replication destinations for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
destinations (list) – [REQUIRED]
An array of objects representing the details of a replication destination.
(dict) –
An array of objects representing the details of a replication destination.
region (string) – [REQUIRED]
A Region to replicate to.
registryId (string) – [REQUIRED]
The account ID of the destination registry to replicate to.
dict
Response Syntax
{
'replicationConfiguration': {
'rules': [
{
'destinations': [
{
'region': 'string',
'registryId': 'string'
},
]
},
]
}
}
Response Structure
(dict) –
replicationConfiguration (dict) –
The contents of the replication configuration for the registry.
rules (list) –
An array of objects representing the replication rules for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
(dict) –
An array of objects representing the replication destinations for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
destinations (list) –
An array of objects representing the details of a replication destination.
(dict) –
An array of objects representing the details of a replication destination.
region (string) –
A Region to replicate to.
registryId (string) –
The account ID of the destination registry to replicate to.
Exceptions
set_repository_policy
(**kwargs)¶Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.set_repository_policy(
registryId='string',
repositoryName='string',
policyText='string',
force=True|False
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to receive the policy.
policyText (string) –
[REQUIRED]
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 .
force (boolean) – 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.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'policyText': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
policyText (string) –
The JSON repository policy text applied to the repository.
Exceptions
start_image_scan
(**kwargs)¶Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_image_scan(
registryId='string',
repositoryName='string',
imageId={
'imageDigest': 'string',
'imageTag': 'string'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository that contains the images to scan.
imageId (dict) –
[REQUIRED]
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'imageScanStatus': {
'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'description': 'string'
}
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
imageId (dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
imageScanStatus (dict) –
The current state of the scan.
status (string) –
The current state of an image scan.
description (string) –
The description of the image scan status.
Exceptions
start_lifecycle_policy_preview
(**kwargs)¶Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
See also: AWS API Documentation
Request Syntax
response = client.start_lifecycle_policy_preview(
registryId='string',
repositoryName='string',
lifecyclePolicyText='string'
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository to be evaluated.
lifecyclePolicyText (string) – The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string',
'status': 'IN_PROGRESS'|'COMPLETE'|'EXPIRED'|'FAILED'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON repository policy text.
status (string) –
The status of the lifecycle policy preview request.
Exceptions
tag_resource
(**kwargs)¶Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.
tags (list) –
[REQUIRED]
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.
(dict) –
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, 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.
Key (string) –
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.
Value (string) –
The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
resourceArn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.
tagKeys (list) –
[REQUIRED]
The keys of the tags to be removed.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
upload_layer_part
(**kwargs)¶Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
See also: AWS API Documentation
Request Syntax
response = client.upload_layer_part(
registryId='string',
repositoryName='string',
uploadId='string',
partFirstByte=123,
partLastByte=123,
layerPartBlob=b'bytes'
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The name of the repository to which you are uploading layer parts.
uploadId (string) –
[REQUIRED]
The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.
partFirstByte (integer) –
[REQUIRED]
The position of the first byte of the layer part witin the overall image layer.
partLastByte (integer) –
[REQUIRED]
The position of the last byte of the layer part within the overall image layer.
layerPartBlob (bytes) –
[REQUIRED]
The base64-encoded layer part payload.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'uploadId': 'string',
'lastByteReceived': 123
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
uploadId (string) –
The upload ID associated with the request.
lastByteReceived (integer) –
The integer value of the last byte received in the request.
Exceptions
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
ECR.Client.exceptions.LifecyclePolicyPreviewInProgressException
ECR.Client.exceptions.LifecyclePolicyPreviewNotFoundException
ECR.Client.exceptions.
EmptyUploadException
¶The specified layer upload does not contain any layer parts.
Example
try:
...
except client.exceptions.EmptyUploadException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified layer upload does not contain any layer parts.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ImageAlreadyExistsException
¶The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
Example
try:
...
except client.exceptions.ImageAlreadyExistsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ImageDigestDoesNotMatchException
¶The specified image digest does not match the digest that Amazon ECR calculated for the image.
Example
try:
...
except client.exceptions.ImageDigestDoesNotMatchException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified image digest does not match the digest that Amazon ECR calculated for the image.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ImageNotFoundException
¶The image requested does not exist in the specified repository.
Example
try:
...
except client.exceptions.ImageNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The image requested does not exist in the specified repository.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ImageTagAlreadyExistsException
¶The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
Example
try:
...
except client.exceptions.ImageTagAlreadyExistsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
InvalidLayerException
¶The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
Example
try:
...
except client.exceptions.InvalidLayerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
InvalidLayerPartException
¶The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.
Example
try:
...
except client.exceptions.InvalidLayerPartException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'uploadId': 'string',
'lastValidByteReceived': 123,
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.
registryId (string) –
The registry ID associated with the exception.
repositoryName (string) –
The repository name associated with the exception.
uploadId (string) –
The upload ID associated with the exception.
lastValidByteReceived (integer) –
The last valid byte received from the layer part upload that is associated with the exception.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
InvalidParameterException
¶The specified parameter is invalid. Review the available parameters for the API request.
Example
try:
...
except client.exceptions.InvalidParameterException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified parameter is invalid. Review the available parameters for the API request.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
InvalidTagParameterException
¶An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Example
try:
...
except client.exceptions.InvalidTagParameterException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
KmsException
¶The operation failed due to a KMS exception.
Example
try:
...
except client.exceptions.KmsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'kmsError': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The operation failed due to a KMS exception.
message (string) –
kmsError (string) –
The error code returned by AWS KMS.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LayerAlreadyExistsException
¶The image layer already exists in the associated repository.
Example
try:
...
except client.exceptions.LayerAlreadyExistsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The image layer already exists in the associated repository.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LayerInaccessibleException
¶The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.
Example
try:
...
except client.exceptions.LayerInaccessibleException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LayerPartTooSmallException
¶Layer parts must be at least 5 MiB in size.
Example
try:
...
except client.exceptions.LayerPartTooSmallException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Layer parts must be at least 5 MiB in size.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LayersNotFoundException
¶The specified layers could not be found, or the specified layer is not valid for this repository.
Example
try:
...
except client.exceptions.LayersNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified layers could not be found, or the specified layer is not valid for this repository.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LifecyclePolicyNotFoundException
¶The lifecycle policy could not be found, and no policy is set to the repository.
Example
try:
...
except client.exceptions.LifecyclePolicyNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The lifecycle policy could not be found, and no policy is set to the repository.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LifecyclePolicyPreviewInProgressException
¶The previous lifecycle policy preview request has not completed. Wait and try again.
Example
try:
...
except client.exceptions.LifecyclePolicyPreviewInProgressException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The previous lifecycle policy preview request has not completed. Wait and try again.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LifecyclePolicyPreviewNotFoundException
¶There is no dry run for this repository.
Example
try:
...
except client.exceptions.LifecyclePolicyPreviewNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There is no dry run for this repository.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
LimitExceededException
¶The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ReferencedImagesNotFoundException
¶The manifest list is referencing an image that does not exist.
Example
try:
...
except client.exceptions.ReferencedImagesNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The manifest list is referencing an image that does not exist.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
RegistryPolicyNotFoundException
¶The registry doesn’t have an associated registry policy.
Example
try:
...
except client.exceptions.RegistryPolicyNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The registry doesn’t have an associated registry policy.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
RepositoryAlreadyExistsException
¶The specified repository already exists in the specified registry.
Example
try:
...
except client.exceptions.RepositoryAlreadyExistsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified repository already exists in the specified registry.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
RepositoryNotEmptyException
¶The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force
parameter.
Example
try:
...
except client.exceptions.RepositoryNotEmptyException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force
parameter.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
RepositoryNotFoundException
¶The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
Example
try:
...
except client.exceptions.RepositoryNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
RepositoryPolicyNotFoundException
¶The specified repository and registry combination does not have an associated repository policy.
Example
try:
...
except client.exceptions.RepositoryPolicyNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified repository and registry combination does not have an associated repository policy.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ScanNotFoundException
¶The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.
Example
try:
...
except client.exceptions.ScanNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ServerException
¶These errors are usually caused by a server-side issue.
Example
try:
...
except client.exceptions.ServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
These errors are usually caused by a server-side issue.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
TooManyTagsException
¶The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
Example
try:
...
except client.exceptions.TooManyTagsException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
UnsupportedImageTypeException
¶The image is of a type that cannot be scanned.
Example
try:
...
except client.exceptions.UnsupportedImageTypeException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The image is of a type that cannot be scanned.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
UploadNotFoundException
¶The upload could not be found, or the specified upload ID is not valid for this repository.
Example
try:
...
except client.exceptions.UploadNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The upload could not be found, or the specified upload ID is not valid for this repository.
message (string) –
The error message associated with the exception.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
ECR.Client.exceptions.
ValidationException
¶There was an exception validating this request.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There was an exception validating this request.
message (string) –
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are:
ECR.Paginator.
DescribeImageScanFindings
¶paginator = client.get_paginator('describe_image_scan_findings')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ECR.Client.describe_image_scan_findings()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registryId='string',
repositoryName='string',
imageId={
'imageDigest': 'string',
'imageTag': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository for the image for which to describe the scan findings.
imageId (dict) –
[REQUIRED]
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'imageId': {
'imageDigest': 'string',
'imageTag': 'string'
},
'imageScanStatus': {
'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'description': 'string'
},
'imageScanFindings': {
'imageScanCompletedAt': datetime(2015, 1, 1),
'vulnerabilitySourceUpdatedAt': datetime(2015, 1, 1),
'findings': [
{
'name': 'string',
'description': 'string',
'uri': 'string',
'severity': 'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'|'UNDEFINED',
'attributes': [
{
'key': 'string',
'value': 'string'
},
]
},
],
'findingSeverityCounts': {
'string': 123
}
},
'NextToken': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
imageId (dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
imageScanStatus (dict) –
The current state of the scan.
status (string) –
The current state of an image scan.
description (string) –
The description of the image scan status.
imageScanFindings (dict) –
The information contained in the image scan findings.
imageScanCompletedAt (datetime) –
The time of the last completed image scan.
vulnerabilitySourceUpdatedAt (datetime) –
The time when the vulnerability data was last scanned.
findings (list) –
The findings from the image scan.
(dict) –
Contains information about an image scan finding.
name (string) –
The name associated with the finding, usually a CVE number.
description (string) –
The description of the finding.
uri (string) –
A link containing additional details about the security vulnerability.
severity (string) –
The finding severity.
attributes (list) –
A collection of attributes of the host from which the finding is generated.
(dict) –
This data type is used in the ImageScanFinding data type.
key (string) –
The attribute key.
value (string) –
The value assigned to the attribute key.
findingSeverityCounts (dict) –
The image vulnerability counts, sorted by severity.
(string) –
(integer) –
NextToken (string) –
A token to resume pagination.
ECR.Paginator.
DescribeImages
¶paginator = client.get_paginator('describe_images')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ECR.Client.describe_images()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository that contains the images to describe.
imageIds (list) –
The list of image IDs for the requested repository.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
filter (dict) –
The filter key and value with which to filter your DescribeImages
results.
tagStatus (string) –
The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'imageDetails': [
{
'registryId': 'string',
'repositoryName': 'string',
'imageDigest': 'string',
'imageTags': [
'string',
],
'imageSizeInBytes': 123,
'imagePushedAt': datetime(2015, 1, 1),
'imageScanStatus': {
'status': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
'description': 'string'
},
'imageScanFindingsSummary': {
'imageScanCompletedAt': datetime(2015, 1, 1),
'vulnerabilitySourceUpdatedAt': datetime(2015, 1, 1),
'findingSeverityCounts': {
'string': 123
}
},
'imageManifestMediaType': 'string',
'artifactMediaType': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
imageDetails (list) –
A list of ImageDetail objects that contain data about the image.
(dict) –
An object that describes an image returned by a DescribeImages operation.
registryId (string) –
The AWS account ID associated with the registry to which this image belongs.
repositoryName (string) –
The name of the repository to which this image belongs.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTags (list) –
The list of tags associated with this image.
(string) –
imageSizeInBytes (integer) –
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.
Note
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 .
imagePushedAt (datetime) –
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
imageScanStatus (dict) –
The current state of the scan.
status (string) –
The current state of an image scan.
description (string) –
The description of the image scan status.
imageScanFindingsSummary (dict) –
A summary of the last completed image scan.
imageScanCompletedAt (datetime) –
The time of the last completed image scan.
vulnerabilitySourceUpdatedAt (datetime) –
The time when the vulnerability data was last scanned.
findingSeverityCounts (dict) –
The image vulnerability counts, sorted by severity.
(string) –
(integer) –
imageManifestMediaType (string) –
The media type of the image manifest.
artifactMediaType (string) –
The artifact media type of the image.
NextToken (string) –
A token to resume pagination.
ECR.Paginator.
DescribeRepositories
¶paginator = client.get_paginator('describe_repositories')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ECR.Client.describe_repositories()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registryId='string',
repositoryNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
registryId (string) – The AWS 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.
repositoryNames (list) –
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
(string) –
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'repositories': [
{
'repositoryArn': 'string',
'registryId': 'string',
'repositoryName': 'string',
'repositoryUri': 'string',
'createdAt': datetime(2015, 1, 1),
'imageTagMutability': 'MUTABLE'|'IMMUTABLE',
'imageScanningConfiguration': {
'scanOnPush': True|False
},
'encryptionConfiguration': {
'encryptionType': 'AES256'|'KMS',
'kmsKey': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
repositories (list) –
A list of repository objects corresponding to valid repositories.
(dict) –
An object representing a repository.
repositoryArn (string) –
The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr
namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test
.
registryId (string) –
The AWS account ID associated with the registry that contains the repository.
repositoryName (string) –
The name of the repository.
repositoryUri (string) –
The URI for the repository. You can use this URI for container image push
and pull
operations.
createdAt (datetime) –
The date and time, in JavaScript date format, when the repository was created.
imageTagMutability (string) –
The tag mutability setting for the repository.
imageScanningConfiguration (dict) –
The image scanning configuration for a repository.
scanOnPush (boolean) –
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 StartImageScan API.
encryptionConfiguration (dict) –
The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.
encryptionType (string) –
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 customer master keys (CMKs) stored in AWS KMS. When you use AWS KMS to encrypt your data, you can either use the default AWS managed CMK for Amazon ECR, or specify your own CMK, which you already created. For more information, see Protecting Data Using Server-Side Encryption with CMKs Stored in AWS 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. .
kmsKey (string) –
If you use the KMS
encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.
NextToken (string) –
A token to resume pagination.
ECR.Paginator.
GetLifecyclePolicyPreview
¶paginator = client.get_paginator('get_lifecycle_policy_preview')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ECR.Client.get_lifecycle_policy_preview()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository.
imageIds (list) –
The list of imageIDs to be included.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
filter (dict) –
An optional parameter that filters results based on image tag status and all tags, if tagged.
tagStatus (string) –
The tag status of the image.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'registryId': 'string',
'repositoryName': 'string',
'lifecyclePolicyText': 'string',
'status': 'IN_PROGRESS'|'COMPLETE'|'EXPIRED'|'FAILED',
'previewResults': [
{
'imageTags': [
'string',
],
'imageDigest': 'string',
'imagePushedAt': datetime(2015, 1, 1),
'action': {
'type': 'EXPIRE'
},
'appliedRulePriority': 123
},
],
'summary': {
'expiringImageTotalCount': 123
},
'NextToken': 'string'
}
Response Structure
(dict) –
registryId (string) –
The registry ID associated with the request.
repositoryName (string) –
The repository name associated with the request.
lifecyclePolicyText (string) –
The JSON lifecycle policy text.
status (string) –
The status of the lifecycle policy preview request.
previewResults (list) –
The results of the lifecycle policy preview request.
(dict) –
The result of the lifecycle policy preview.
imageTags (list) –
The list of tags associated with this image.
(string) –
imageDigest (string) –
The sha256
digest of the image manifest.
imagePushedAt (datetime) –
The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.
action (dict) –
The type of action to be taken.
type (string) –
The type of action to be taken.
appliedRulePriority (integer) –
The priority of the applied rule.
summary (dict) –
The list of images that is returned as a result of the action.
expiringImageTotalCount (integer) –
The number of expiring images.
NextToken (string) –
A token to resume pagination.
ECR.Paginator.
ListImages
¶paginator = client.get_paginator('list_images')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from ECR.Client.list_images()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
registryId='string',
repositoryName='string',
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository with image IDs to be listed.
filter (dict) –
The filter key and value with which to filter your ListImages
results.
tagStatus (string) –
The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED
or UNTAGGED
.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken
will be provided in the output that you can use to resume pagination.
PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'imageIds': [
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) –
imageIds (list) –
The list of image IDs for the requested repository.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
NextToken (string) –
A token to resume pagination.
The available waiters are:
ECR.Waiter.
ImageScanComplete
¶waiter = client.get_waiter('image_scan_complete')
wait
(**kwargs)¶Polls ECR.Client.describe_image_scan_findings()
every 5 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
registryId='string',
repositoryName='string',
imageId={
'imageDigest': 'string',
'imageTag': 'string'
},
nextToken='string',
maxResults=123,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
registryId (string) – The AWS 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.
repositoryName (string) –
[REQUIRED]
The repository for the image for which to describe the scan findings.
imageId (dict) –
[REQUIRED]
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) – 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.
maxResults (integer) – 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.
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
Delay (integer) –
The amount of time in seconds to wait between attempts. Default: 5
MaxAttempts (integer) –
The maximum number of attempts to be made. Default: 60
None
ECR.Waiter.
LifecyclePolicyPreviewComplete
¶waiter = client.get_waiter('lifecycle_policy_preview_complete')
wait
(**kwargs)¶Polls ECR.Client.get_lifecycle_policy_preview()
every 5 seconds until a successful state is reached. An error is returned after 20 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
registryId='string',
repositoryName='string',
imageIds=[
{
'imageDigest': 'string',
'imageTag': 'string'
},
],
nextToken='string',
maxResults=123,
filter={
'tagStatus': 'TAGGED'|'UNTAGGED'|'ANY'
},
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
registryId (string) – The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName (string) –
[REQUIRED]
The name of the repository.
imageIds (list) –
The list of imageIDs to be included.
(dict) –
An object with identifying information for an Amazon ECR image.
imageDigest (string) –
The sha256
digest of the image manifest.
imageTag (string) –
The tag used for the image.
nextToken (string) – 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
.
maxResults (integer) – 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
.
filter (dict) –
An optional parameter that filters results based on image tag status and all tags, if tagged.
tagStatus (string) –
The tag status of the image.
WaiterConfig (dict) –
A dictionary that provides parameters to control waiting behavior.
Delay (integer) –
The amount of time in seconds to wait between attempts. Default: 5
MaxAttempts (integer) –
The maximum number of attempts to be made. Default: 20
None