Class: AWS.ECR

/* This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account. */

 var params = {
  imageIds: [
     {
    imageTag: "precise"
   }
  ], 
  repositoryName: "ubuntu"
 };
 ecr.batchDeleteImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    failures: [
    ], 
    imageIds: [
       {
      imageDigest: "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f", 
      imageTag: "precise"
     }
    ]
   }
   */
 });

var params = {
  imageIds: [ /* required */
    {
      imageDigest: 'STRING_VALUE',
      imageTag: 'STRING_VALUE'
    },
    /* more items */
  ],
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.batchDeleteImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The repository that contains the image to delete.

  • imageIds — (Array<map>)

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

    • imageDigest — (String)

      The sha256 digest of the image manifest.

    • imageTag — (String)

      The tag used for the image.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • imageIds — (Array<map>)

      The image IDs of the deleted images.

      • imageDigest — (String)

        The sha256 digest of the image manifest.

      • imageTag — (String)

        The tag used for the image.

    • failures — (Array<map>)

      Any failures associated with the call.

      • imageId — (map)

        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.

        Possible values include:
        • "InvalidImageDigest"
        • "InvalidImageTag"
        • "ImageTagDoesNotMatchDigest"
        • "ImageNotFound"
        • "MissingDigestAndTag"
        • "ImageReferencedByManifestList"
        • "KmsError"
        • "UpstreamAccessDenied"
        • "UpstreamTooManyRequests"
        • "UpstreamUnavailable"
      • failureReason — (String)

        The reason for the failure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account. */

 var params = {
  imageIds: [
     {
    imageTag: "precise"
   }
  ], 
  repositoryName: "ubuntu"
 };
 ecr.batchGetImage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    failures: [
    ], 
    images: [
       {
      imageId: {
       imageDigest: "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a", 
       imageTag: "precise"
      }, 
      imageManifest: "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...", 
      registryId: "244698725403", 
      repositoryName: "ubuntu"
     }
    ]
   }
   */
 });

var params = {
  imageIds: [ /* required */
    {
      imageDigest: 'STRING_VALUE',
      imageTag: 'STRING_VALUE'
    },
    /* more items */
  ],
  repositoryName: 'STRING_VALUE', /* required */
  acceptedMediaTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  registryId: 'STRING_VALUE'
};
ecr.batchGetImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The repository that contains the images to describe.

  • imageIds — (Array<map>)

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

    • imageDigest — (String)

      The sha256 digest of the image manifest.

    • imageTag — (String)

      The tag used for the image.

  • acceptedMediaTypes — (Array<String>)

    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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • images — (Array<map>)

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

      • registryId — (String)

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

      • repositoryName — (String)

        The name of the repository associated with the image.

      • imageId — (map)

        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 — (Array<map>)

      Any failures associated with the call.

      • imageId — (map)

        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.

        Possible values include:
        • "InvalidImageDigest"
        • "InvalidImageTag"
        • "ImageTagDoesNotMatchDigest"
        • "ImageNotFound"
        • "MissingDigestAndTag"
        • "ImageReferencedByManifestList"
        • "KmsError"
        • "UpstreamAccessDenied"
        • "UpstreamTooManyRequests"
        • "UpstreamUnavailable"
      • failureReason — (String)

        The reason for the failure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ecr.batchGetRepositoryScanningConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • repositoryNames — (Array<String>)

    One or more repository names to get the scanning configuration for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • scanningConfigurations — (Array<map>)

      The scanning configuration for the requested repositories.

      • repositoryArn — (String)

        The ARN of the repository.

      • repositoryName — (String)

        The name of the repository.

      • scanOnPush — (Boolean)

        Whether or not scan on push is configured for the repository.

      • scanFrequency — (String)

        The scan frequency for the repository.

        Possible values include:
        • "SCAN_ON_PUSH"
        • "CONTINUOUS_SCAN"
        • "MANUAL"
      • appliedScanFilters — (Array<map>)

        The scan filters applied to the repository.

        • filter — required — (String)

          The filter to use when scanning.

        • filterType — required — (String)

          The type associated with the filter.

          Possible values include:
          • "WILDCARD"
    • failures — (Array<map>)

      Any failures associated with the call.

      • repositoryName — (String)

        The name of the repository.

      • failureCode — (String)

        The failure code.

        Possible values include:
        • "REPOSITORY_NOT_FOUND"
      • failureReason — (String)

        The reason for the failure.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  layerDigests: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  repositoryName: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.completeLayerUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

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

  • uploadId — (String)

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

  • layerDigests — (Array<String>)

    The sha256 digest of the image layer.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ecrRepositoryPrefix: 'STRING_VALUE', /* required */
  upstreamRegistryUrl: 'STRING_VALUE', /* required */
  credentialArn: 'STRING_VALUE',
  registryId: 'STRING_VALUE',
  upstreamRegistry: ecr-public | quay | k8s | docker-hub | github-container-registry | azure-container-registry | gitlab-container-registry
};
ecr.createPullThroughCacheRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ecrRepositoryPrefix — (String)

    The repository name prefix to use when caching images from the source registry.

  • upstreamRegistryUrl — (String)

    The registry URL of the upstream public registry to use as the source for the pull through cache rule. The following is the syntax to use for each supported upstream registry.

    • Amazon ECR Public (ecr-public) - public.ecr.aws

    • Docker Hub (docker-hub) - registry-1.docker.io

    • Quay (quay) - quay.io

    • Kubernetes (k8s) - registry.k8s.io

    • GitHub Container Registry (github-container-registry) - ghcr.io

    • Microsoft Azure Container Registry (azure-container-registry) - <custom>.azurecr.io

  • registryId — (String)

    The Amazon Web Services account ID associated with the registry to create the pull through cache rule for. If you do not specify a registry, the default registry is assumed.

  • upstreamRegistry — (String)

    The name of the upstream registry.

    Possible values include:
    • "ecr-public"
    • "quay"
    • "k8s"
    • "docker-hub"
    • "github-container-registry"
    • "azure-container-registry"
    • "gitlab-container-registry"
  • credentialArn — (String)

    The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that identifies the credentials to authenticate to the upstream registry.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ecrRepositoryPrefix — (String)

      The Amazon ECR repository prefix associated with the pull through cache rule.

    • upstreamRegistryUrl — (String)

      The upstream registry URL associated with the pull through cache rule.

    • createdAt — (Date)

      The date and time, in JavaScript date format, when the pull through cache rule was created.

    • registryId — (String)

      The registry ID associated with the request.

    • upstreamRegistry — (String)

      The name of the upstream registry associated with the pull through cache rule.

      Possible values include:
      • "ecr-public"
      • "quay"
      • "k8s"
      • "docker-hub"
      • "github-container-registry"
      • "azure-container-registry"
      • "gitlab-container-registry"
    • credentialArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account. */

 var params = {
  repositoryName: "project-a/nginx-web-app"
 };
 ecr.createRepository(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    repository: {
     registryId: "012345678901", 
     repositoryArn: "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app", 
     repositoryName: "project-a/nginx-web-app"
    }
   }
   */
 });

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  encryptionConfiguration: {
    encryptionType: AES256 | KMS, /* required */
    kmsKey: 'STRING_VALUE'
  },
  imageScanningConfiguration: {
    scanOnPush: true || false
  },
  imageTagMutability: MUTABLE | IMMUTABLE,
  registryId: 'STRING_VALUE',
  tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ecr.createRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

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

    The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.

  • tags — (Array<map>)

    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.

    • Key — required — (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 — required — (String)

      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.

    Possible values include:
    • "MUTABLE"
    • "IMMUTABLE"
  • imageScanningConfiguration — (map)

    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 API_StartImageScan API.

  • encryptionConfiguration — (map)

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

    • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

      If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

      Possible values include:
      • "AES256"
      • "KMS"
    • kmsKey — (String)

      If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      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, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.

      • registryId — (String)

        The Amazon Web Services 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 — (Date)

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

      • imageTagMutability — (String)

        The tag mutability setting for the repository.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • imageScanningConfiguration — (map)

        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 API_StartImageScan API.

      • encryptionConfiguration — (map)

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

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example creates a repository creation template. */

 var params = {
  appliedFor: [
     "REPLICATION", 
     "PULL_THROUGH_CACHE"
  ], 
  description: "Repos for testing images", 
  encryptionConfiguration: {
   encryptionType: "AES256"
  }, 
  imageTagMutability: "MUTABLE", 
  lifecyclePolicy: "{\r\n    \"rules\": [\r\n        {\r\n            \"rulePriority\": 1,\r\n            \"description\": \"Expire images older than 14 days\",\r\n            \"selection\": {\r\n                \"tagStatus\": \"untagged\",\r\n                \"countType\": \"sinceImagePushed\",\r\n                \"countUnit\": \"days\",\r\n                \"countNumber\": 14\r\n            },\r\n            \"action\": {\r\n                \"type\": \"expire\"\r\n            }\r\n        }\r\n    ]\r\n}", 
  prefix: "eng/test", 
  repositoryPolicy: "{\r\n  \"Version\": \"2012-10-17\",\r\n  \"Statement\": [\r\n    {\r\n      \"Sid\": \"LambdaECRPullPolicy\",\r\n      \"Effect\": \"Allow\",\r\n      \"Principal\": {\r\n        \"Service\": \"lambda.amazonaws.com\"\r\n      },\r\n      \"Action\": \"ecr:BatchGetImage\"\r\n    }\r\n  ]\r\n}", 
  resourceTags: [
     {
    Key: "environment", 
    Value: "test"
   }
  ]
 };
 ecr.createRepositoryCreationTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    registryId: "012345678901", 
    repositoryCreationTemplate: {
     appliedFor: [
        "REPLICATION", 
        "PULL_THROUGH_CACHE"
     ], 
     createdAt: <Date Representation>, 
     description: "Repos for testing images", 
     encryptionConfiguration: {
      encryptionType: "AES256"
     }, 
     imageTagMutability: "MUTABLE", 
     lifecyclePolicy: "{\r\n    \"rules\": [\r\n        {\r\n            \"rulePriority\": 1,\r\n            \"description\": \"Expire images older than 14 days\",\r\n            \"selection\": {\r\n                \"tagStatus\": \"untagged\",\r\n                \"countType\": \"sinceImagePushed\",\r\n                \"countUnit\": \"days\",\r\n                \"countNumber\": 14\r\n            },\r\n            \"action\": {\r\n                \"type\": \"expire\"\r\n            }\r\n        }\r\n    ]\r\n}", 
     prefix: "eng/test", 
     repositoryPolicy: "{\n  \"Version\" : \"2012-10-17\",\n  \"Statement\" : [ {\n    \"Sid\" : \"LambdaECRPullPolicy\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n      \"Service\" : \"lambda.amazonaws.com\"\n    },\n    \"Action\" : \"ecr:BatchGetImage\"\n  } ]\n}", 
     resourceTags: [
        {
       Key: "environment", 
       Value: "test"
      }
     ], 
     updatedAt: <Date Representation>
    }
   }
   */
 });

var params = {
  appliedFor: [ /* required */
    REPLICATION | PULL_THROUGH_CACHE,
    /* more items */
  ],
  prefix: 'STRING_VALUE', /* required */
  customRoleArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  encryptionConfiguration: {
    encryptionType: AES256 | KMS, /* required */
    kmsKey: 'STRING_VALUE'
  },
  imageTagMutability: MUTABLE | IMMUTABLE,
  lifecyclePolicy: 'STRING_VALUE',
  repositoryPolicy: 'STRING_VALUE',
  resourceTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ecr.createRepositoryCreationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • prefix — (String)

    The repository namespace prefix to associate with the template. All repositories created using this namespace prefix will have the settings defined in this template applied. For example, a prefix of prod would apply to all repositories beginning with prod/. Similarly, a prefix of prod/team would apply to all repositories beginning with prod/team/.

    To apply a template to all repositories in your registry that don't have an associated creation template, you can use ROOT as the prefix.

    There is always an assumed / applied to the end of the prefix. If you specify ecr-public as the prefix, Amazon ECR treats that as ecr-public/. When using a pull through cache rule, the repository prefix you specify during rule creation is what you should specify as your repository creation template prefix as well.

  • description — (String)

    A description for the repository creation template.

  • encryptionConfiguration — (map)

    The encryption configuration to use for repositories created using the template.

    • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

      If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

      Possible values include:
      • "AES256"
      • "KMS"
    • kmsKey — (String)

      If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

  • resourceTags — (Array<map>)

    The metadata to apply to the repository to help you categorize and organize. 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 — required — (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 — required — (String)

      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.

    Possible values include:
    • "MUTABLE"
    • "IMMUTABLE"
  • repositoryPolicy — (String)

    The repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

  • lifecyclePolicy — (String)

    The lifecycle policy to use for repositories created using the template.

  • appliedFor — (Array<String>)

    A list of enumerable strings representing the Amazon ECR repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

  • customRoleArn — (String)

    The ARN of the role to be assumed by Amazon ECR. This role must be in the same account as the registry that you are configuring. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryCreationTemplate — (map)

      The details of the repository creation template associated with the request.

      • prefix — (String)

        The repository namespace prefix associated with the repository creation template.

      • description — (String)

        The description associated with the repository creation template.

      • encryptionConfiguration — (map)

        The encryption configuration associated with the repository creation template.

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

      • resourceTags — (Array<map>)

        The metadata to apply to the repository to help you categorize and organize. 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 — required — (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 — required — (String)

          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.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • repositoryPolicy — (String)

        he repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

      • lifecyclePolicy — (String)

        The lifecycle policy to use for repositories created using the template.

      • appliedFor — (Array<String>)

        A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

      • customRoleArn — (String)

        The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

      • createdAt — (Date)

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

      • updatedAt — (Date)

        The date and time, in JavaScript date format, when the repository creation template was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.deleteLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ecrRepositoryPrefix: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.deletePullThroughCacheRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ecrRepositoryPrefix — (String)

    The Amazon ECR repository prefix associated with the pull through cache rule to delete.

  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the pull through cache rule. If you do not specify a registry, the default registry is assumed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ecrRepositoryPrefix — (String)

      The Amazon ECR repository prefix associated with the request.

    • upstreamRegistryUrl — (String)

      The upstream registry URL associated with the pull through cache rule.

    • createdAt — (Date)

      The timestamp associated with the pull through cache rule.

    • registryId — (String)

      The registry ID associated with the request.

    • credentialArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret associated with the pull through cache rule.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
};
ecr.deleteRegistryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • policyText — (String)

      The contents of the registry permissions policy that was deleted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* 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. */

 var params = {
  force: true, 
  repositoryName: "ubuntu"
 };
 ecr.deleteRepository(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    repository: {
     registryId: "012345678901", 
     repositoryArn: "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu", 
     repositoryName: "ubuntu"
    }
   }
   */
 });

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  force: true || false,
  registryId: 'STRING_VALUE'
};
ecr.deleteRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository to delete.

  • force — (Boolean)

    If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repository — (map)

      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, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.

      • registryId — (String)

        The Amazon Web Services 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 — (Date)

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

      • imageTagMutability — (String)

        The tag mutability setting for the repository.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • imageScanningConfiguration — (map)

        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 API_StartImageScan API.

      • encryptionConfiguration — (map)

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

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes a repository creation template. */

 var params = {
  prefix: "eng"
 };
 ecr.deleteRepositoryCreationTemplate(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    registryId: "012345678901", 
    repositoryCreationTemplate: {
     createdAt: <Date Representation>, 
     encryptionConfiguration: {
      encryptionType: "AES256"
     }, 
     imageTagMutability: "MUTABLE", 
     prefix: "eng", 
     updatedAt: <Date Representation>
    }
   }
   */
 });

var params = {
  prefix: 'STRING_VALUE' /* required */
};
ecr.deleteRepositoryCreationTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • prefix — (String)

    The repository namespace prefix associated with the repository creation template.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryCreationTemplate — (map)

      The details of the repository creation template that was deleted.

      • prefix — (String)

        The repository namespace prefix associated with the repository creation template.

      • description — (String)

        The description associated with the repository creation template.

      • encryptionConfiguration — (map)

        The encryption configuration associated with the repository creation template.

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

      • resourceTags — (Array<map>)

        The metadata to apply to the repository to help you categorize and organize. 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 — required — (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 — required — (String)

          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.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • repositoryPolicy — (String)

        he repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

      • lifecyclePolicy — (String)

        The lifecycle policy to use for repositories created using the template.

      • appliedFor — (Array<String>)

        A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

      • customRoleArn — (String)

        The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

      • createdAt — (Date)

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

      • updatedAt — (Date)

        The date and time, in JavaScript date format, when the repository creation template was last updated.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example deletes the policy associated with the repository named ubuntu in the current account. */

 var params = {
  repositoryName: "ubuntu"
 };
 ecr.deleteRepositoryPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    policyText: "{ ... }", 
    registryId: "012345678901", 
    repositoryName: "ubuntu"
   }
   */
 });

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.deleteRepositoryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageId: { /* required */
    imageDigest: 'STRING_VALUE',
    imageTag: 'STRING_VALUE'
  },
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.describeImageReplicationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • repositoryName — (String)

    The name of the repository that the image is in.

  • imageId — (map)

    An object with identifying information for an image in an Amazon ECR repository.

    • imageDigest — (String)

      The sha256 digest of the image manifest.

    • imageTag — (String)

      The tag used for the image.

  • registryId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repositoryName — (String)

      The repository name associated with the request.

    • imageId — (map)

      An object with identifying information for an image in an Amazon ECR repository.

      • imageDigest — (String)

        The sha256 digest of the image manifest.

      • imageTag — (String)

        The tag used for the image.

    • replicationStatuses — (Array<map>)

      The replication status details for the images in the specified repository.

      • region — (String)

        The destination Region for the image replication.

      • registryId — (String)

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

      • status — (String)

        The image replication status.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
      • failureCode — (String)

        The failure code for a replication that has failed.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  filter: {
    tagStatus: TAGGED | UNTAGGED | ANY
  },
  imageIds: [
    {
      imageDigest: 'STRING_VALUE',
      imageTag: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.describeImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

    The repository that contains the images to describe.

  • imageIds — (Array<map>)

    The list of image IDs for the requested repository.

    • 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 — (map)

    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.

      Possible values include:
      • "TAGGED"
      • "UNTAGGED"
      • "ANY"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • imageDetails — (Array<map>)

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

      • registryId — (String)

        The Amazon Web Services 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 — (Array<String>)

        The list of tags associated with this image.

      • 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 — (Date)

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

      • imageScanStatus — (map)

        The current state of the scan.

        • status — (String)

          The current state of an image scan.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETE"
          • "FAILED"
          • "UNSUPPORTED_IMAGE"
          • "ACTIVE"
          • "PENDING"
          • "SCAN_ELIGIBILITY_EXPIRED"
          • "FINDINGS_UNAVAILABLE"
        • description — (String)

          The description of the image scan status.

      • imageScanFindingsSummary — (map)

        A summary of the last completed image scan.

        • imageScanCompletedAt — (Date)

          The time of the last completed image scan.

        • vulnerabilitySourceUpdatedAt — (Date)

          The time when the vulnerability data was last scanned.

        • findingSeverityCounts — (map<Integer>)

          The image vulnerability counts, sorted by severity.

      • imageManifestMediaType — (String)

        The media type of the image manifest.

      • artifactMediaType — (String)

        The artifact media type of the image.

      • lastRecordedPullTime — (Date)

        The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.

        Note: Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the lastRecordedPullTime timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the lastRecordedPullTime timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.
    • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageId: { /* required */
    imageDigest: 'STRING_VALUE',
    imageTag: 'STRING_VALUE'
  },
  repositoryName: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.describeImageScanFindings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • imageId — (map)

    An object with identifying information for an image in an Amazon ECR repository.

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryName — (String)

      The repository name associated with the request.

    • imageId — (map)

      An object with identifying information for an image in an Amazon ECR repository.

      • imageDigest — (String)

        The sha256 digest of the image manifest.

      • imageTag — (String)

        The tag used for the image.

    • imageScanStatus — (map)

      The current state of the scan.

      • status — (String)

        The current state of an image scan.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
        • "UNSUPPORTED_IMAGE"
        • "ACTIVE"
        • "PENDING"
        • "SCAN_ELIGIBILITY_EXPIRED"
        • "FINDINGS_UNAVAILABLE"
      • description — (String)

        The description of the image scan status.

    • imageScanFindings — (map)

      The information contained in the image scan findings.

      • imageScanCompletedAt — (Date)

        The time of the last completed image scan.

      • vulnerabilitySourceUpdatedAt — (Date)

        The time when the vulnerability data was last scanned.

      • findingSeverityCounts — (map<Integer>)

        The image vulnerability counts, sorted by severity.

      • findings — (Array<map>)

        The findings from the image scan.

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

          Possible values include:
          • "INFORMATIONAL"
          • "LOW"
          • "MEDIUM"
          • "HIGH"
          • "CRITICAL"
          • "UNDEFINED"
        • attributes — (Array<map>)

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

          • key — required — (String)

            The attribute key.

          • value — (String)

            The value assigned to the attribute key.

      • enhancedFindings — (Array<map>)

        Details about the enhanced scan findings from Amazon Inspector.

        • awsAccountId — (String)

          The Amazon Web Services account ID associated with the image.

        • description — (String)

          The description of the finding.

        • findingArn — (String)

          The Amazon Resource Number (ARN) of the finding.

        • firstObservedAt — (Date)

          The date and time that the finding was first observed.

        • lastObservedAt — (Date)

          The date and time that the finding was last observed.

        • packageVulnerabilityDetails — (map)

          An object that contains the details of a package vulnerability finding.

          • cvss — (Array<map>)

            An object that contains details about the CVSS score of a finding.

            • baseScore — (Float)

              The base CVSS score used for the finding.

            • scoringVector — (String)

              The vector string of the CVSS score.

            • source — (String)

              The source of the CVSS score.

            • version — (String)

              The version of CVSS used for the score.

          • referenceUrls — (Array<String>)

            One or more URLs that contain details about this vulnerability type.

          • relatedVulnerabilities — (Array<String>)

            One or more vulnerabilities related to the one identified in this finding.

          • source — (String)

            The source of the vulnerability information.

          • sourceUrl — (String)

            A URL to the source of the vulnerability information.

          • vendorCreatedAt — (Date)

            The date and time that this vulnerability was first added to the vendor's database.

          • vendorSeverity — (String)

            The severity the vendor has given to this vulnerability type.

          • vendorUpdatedAt — (Date)

            The date and time the vendor last updated this vulnerability in their database.

          • vulnerabilityId — (String)

            The ID given to this vulnerability.

          • vulnerablePackages — (Array<map>)

            The packages impacted by this vulnerability.

            • arch — (String)

              The architecture of the vulnerable package.

            • epoch — (Integer)

              The epoch of the vulnerable package.

            • filePath — (String)

              The file path of the vulnerable package.

            • name — (String)

              The name of the vulnerable package.

            • packageManager — (String)

              The package manager of the vulnerable package.

            • release — (String)

              The release of the vulnerable package.

            • sourceLayerHash — (String)

              The source layer hash of the vulnerable package.

            • version — (String)

              The version of the vulnerable package.

        • remediation — (map)

          An object that contains the details about how to remediate a finding.

          • recommendation — (map)

            An object that contains information about the recommended course of action to remediate the finding.

            • url — (String)

              The URL address to the CVE remediation recommendations.

            • text — (String)

              The recommended course of action to remediate the finding.

        • resources — (Array<map>)

          Contains information on the resources involved in a finding.

          • details — (map)

            An object that contains details about the resource involved in a finding.

            • awsEcrContainerImage — (map)

              An object that contains details about the Amazon ECR container image involved in the finding.

              • architecture — (String)

                The architecture of the Amazon ECR container image.

              • author — (String)

                The image author of the Amazon ECR container image.

              • imageHash — (String)

                The image hash of the Amazon ECR container image.

              • imageTags — (Array<String>)

                The image tags attached to the Amazon ECR container image.

              • platform — (String)

                The platform of the Amazon ECR container image.

              • pushedAt — (Date)

                The date and time the Amazon ECR container image was pushed.

              • registry — (String)

                The registry the Amazon ECR container image belongs to.

              • repositoryName — (String)

                The name of the repository the Amazon ECR container image resides in.

          • id — (String)

            The ID of the resource.

          • tags — (map<String>)

            The tags attached to the resource.

          • type — (String)

            The type of resource.

        • score — (Float)

          The Amazon Inspector score given to the finding.

        • scoreDetails — (map)

          An object that contains details of the Amazon Inspector score.

          • cvss — (map)

            An object that contains details about the CVSS score given to a finding.

            • adjustments — (Array<map>)

              An object that contains details about adjustment Amazon Inspector made to the CVSS score.

              • metric — (String)

                The metric used to adjust the CVSS score.

              • reason — (String)

                The reason the CVSS score has been adjustment.

            • score — (Float)

              The CVSS score.

            • scoreSource — (String)

              The source for the CVSS score.

            • scoringVector — (String)

              The vector for the CVSS score.

            • version — (String)

              The CVSS version used in scoring.

        • severity — (String)

          The severity of the finding.

        • status — (String)

          The status of the finding.

        • title — (String)

          The title of the finding.

        • type — (String)

          The type of the finding.

        • updatedAt — (Date)

          The date and time the finding was last updated at.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• imageScanComplete

var params = {
  ecrRepositoryPrefixes: [
    'STRING_VALUE',
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.describePullThroughCacheRules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

  • ecrRepositoryPrefixes — (Array<String>)

    The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

  • nextToken — (String)

    The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest 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 pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest 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 DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pullThroughCacheRules — (Array<map>)

      The details of the pull through cache rules.

      • ecrRepositoryPrefix — (String)

        The Amazon ECR repository prefix associated with the pull through cache rule.

      • upstreamRegistryUrl — (String)

        The upstream registry URL associated with the pull through cache rule.

      • createdAt — (Date)

        The date and time the pull through cache was created.

      • registryId — (String)

        The Amazon Web Services account ID associated with the registry the pull through cache rule is associated with.

      • credentialArn — (String)

        The ARN of the Secrets Manager secret associated with the pull through cache rule.

      • upstreamRegistry — (String)

        The name of the upstream source registry associated with the pull through cache rule.

        Possible values include:
        • "ecr-public"
        • "quay"
        • "k8s"
        • "docker-hub"
        • "github-container-registry"
        • "azure-container-registry"
        • "gitlab-container-registry"
      • updatedAt — (Date)

        The date and time, in JavaScript date format, when the pull through cache rule was last updated.

    • nextToken — (String)

      The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
};
ecr.describeRegistry(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • replicationConfiguration — (map)

      The replication configuration for the registry.

      • rules — required — (Array<map>)

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

        • destinations — required — (Array<map>)

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

          • region — required — (String)

            The Region to replicate to.

          • registryId — required — (String)

            The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

        • repositoryFilters — (Array<map>)

          An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

          • filter — required — (String)

            The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

          • filterType — required — (String)

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

            Possible values include:
            • "PREFIX_MATCH"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* The following example obtains a list and description of all repositories in the default registry to which the current user has access. */

 var params = {
 };
 ecr.describeRepositories(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
     }
    ]
   }
   */
 });

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE',
  repositoryNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
ecr.describeRepositories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryNames — (Array<String>)

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

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • repositories — (Array<map>)

      A list of repository objects corresponding to valid repositories.

      • 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, Amazon Web Services account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository-namespace/repository-name.

      • registryId — (String)

        The Amazon Web Services 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 — (Date)

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

      • imageTagMutability — (String)

        The tag mutability setting for the repository.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • imageScanningConfiguration — (map)

        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 API_StartImageScan API.

      • encryptionConfiguration — (map)

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

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example describes the contents of a repository creation template. */

 var params = {
  maxResults: 123, 
  nextToken: "", 
  prefixes: [
     "eng"
  ]
 };
 ecr.describeRepositoryCreationTemplates(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    nextToken: "", 
    registryId: "012345678901", 
    repositoryCreationTemplates: [
       {
      appliedFor: [
         "PULL_THROUGH_CACHE", 
         "REPLICATION"
      ], 
      createdAt: <Date Representation>, 
      encryptionConfiguration: {
       encryptionType: "AES256"
      }, 
      imageTagMutability: "MUTABLE", 
      prefix: "eng/test", 
      updatedAt: <Date Representation>
     }, 
       {
      appliedFor: [
         "REPLICATION"
      ], 
      createdAt: <Date Representation>, 
      encryptionConfiguration: {
       encryptionType: "AES256"
      }, 
      imageTagMutability: "IMMUTABLE", 
      prefix: "eng/replication-test", 
      updatedAt: <Date Representation>
     }
    ]
   }
   */
 });

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  prefixes: [
    'STRING_VALUE',
    /* more items */
  ]
};
ecr.describeRepositoryCreationTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • prefixes — (Array<String>)

    The repository namespace prefixes associated with the repository creation templates to describe. If this value is not specified, all repository creation templates are returned.

  • nextToken — (String)

    The nextToken value returned from a previous paginated DescribeRepositoryCreationTemplates 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 repository results returned by DescribeRepositoryCreationTemplatesRequest in paginated output. When this parameter is used, DescribeRepositoryCreationTemplatesRequest 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 DescribeRepositoryCreationTemplatesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositoryCreationTemplatesRequest returns up to 100 results and a nextToken value, if applicable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryCreationTemplates — (Array<map>)

      The details of the repository creation templates.

      • prefix — (String)

        The repository namespace prefix associated with the repository creation template.

      • description — (String)

        The description associated with the repository creation template.

      • encryptionConfiguration — (map)

        The encryption configuration associated with the repository creation template.

        • encryptionType — required — (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 Key Management Service key stored in KMS. When you use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see Protecting data using server-side encryption with an KMS key stored in Key Management Service (SSE-KMS) in the Amazon Simple Storage Service Console Developer Guide.

          If you use the AES256 encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES256 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.

          Possible values include:
          • "AES256"
          • "KMS"
        • kmsKey — (String)

          If you use the KMS encryption type, specify the KMS key to use for encryption. The full ARN of the KMS key must be specified. The key must exist in the same Region as the repository. If no key is specified, the default Amazon Web Services managed KMS key for Amazon ECR will be used.

      • resourceTags — (Array<map>)

        The metadata to apply to the repository to help you categorize and organize. 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 — required — (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 — required — (String)

          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.

        Possible values include:
        • "MUTABLE"
        • "IMMUTABLE"
      • repositoryPolicy — (String)

        he repository policy to apply to repositories created using the template. A repository policy is a permissions policy associated with a repository to control access permissions.

      • lifecyclePolicy — (String)

        The lifecycle policy to use for repositories created using the template.

      • appliedFor — (Array<String>)

        A list of enumerable Strings representing the repository creation scenarios that this template will apply towards. The two supported scenarios are PULL_THROUGH_CACHE and REPLICATION

      • customRoleArn — (String)

        The ARN of the role to be assumed by Amazon ECR. Amazon ECR will assume your supplied role when the customRoleArn is specified. When this field isn't specified, Amazon ECR will use the service-linked role for the repository creation template.

      • createdAt — (Date)

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

      • updatedAt — (Date)

        The date and time, in JavaScript date format, when the repository creation template was last updated.

    • nextToken — (String)

      The nextToken value to include in a future DescribeRepositoryCreationTemplates request. When the results of a DescribeRepositoryCreationTemplates 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE' /* required */
};
ecr.getAccountSetting(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Basic scan type version name.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      Retrieves the basic scan type version name.

    • value — (String)

      Retrieves the value that specifies what basic scan type is being used: AWS_NATIVE or CLAIR.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example gets an authorization token for your default registry. */

 var params = {
 };
 ecr.getAuthorizationToken(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    authorizationData: [
       {
      authorizationToken: "QVdTOkNEXAMPLE", 
      expiresAt: <Date Representation>, 
      proxyEndpoint: "https://012345678901.dkr.ecr.us-west-2.amazonaws.com"
     }
    ]
   }
   */
 });

var params = {
  registryIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
ecr.getAuthorizationToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryIds — (Array<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • authorizationData — (Array<map>)

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

      • 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 — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  layerDigest: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.getDownloadUrlForLayer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • layerDigest — (String)

    The digest of the image layer to download.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • downloadUrl — (String)

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

    • layerDigest — (String)

      The digest of the image layer to download.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.getLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Date)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  filter: {
    tagStatus: TAGGED | UNTAGGED | ANY
  },
  imageIds: [
    {
      imageDigest: 'STRING_VALUE',
      imageTag: 'STRING_VALUE'
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.getLifecyclePolicyPreview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository.

  • imageIds — (Array<map>)

    The list of imageIDs to be included.

    • 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 — (map)

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

    • tagStatus — (String)

      The tag status of the image.

      Possible values include:
      • "TAGGED"
      • "UNTAGGED"
      • "ANY"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "IN_PROGRESS"
      • "COMPLETE"
      • "EXPIRED"
      • "FAILED"
    • 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 — (Array<map>)

      The results of the lifecycle policy preview request.

      • imageTags — (Array<String>)

        The list of tags associated with this image.

      • imageDigest — (String)

        The sha256 digest of the image manifest.

      • imagePushedAt — (Date)

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

      • action — (map)

        The type of action to be taken.

        • type — (String)

          The type of action to be taken.

          Possible values include:
          • "EXPIRE"
      • appliedRulePriority — (Integer)

        The priority of the applied rule.

    • summary — (map)

      The list of images that is returned as a result of the action.

      • expiringImageTotalCount — (Integer)

        The number of expiring images.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

• lifecyclePolicyPreviewComplete

var params = {
};
ecr.getRegistryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • policyText — (String)

      The JSON text of the permissions policy for a registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
};
ecr.getRegistryScanningConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • scanningConfiguration — (map)

      The scanning configuration for the registry.

      • scanType — (String)

        The type of scanning configured for the registry.

        Possible values include:
        • "BASIC"
        • "ENHANCED"
      • rules — (Array<map>)

        The scanning rules associated with the registry.

        • scanFrequency — required — (String)

          The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

          Possible values include:
          • "SCAN_ON_PUSH"
          • "CONTINUOUS_SCAN"
          • "MANUAL"
        • repositoryFilters — required — (Array<map>)

          The repository filters associated with the scanning configuration for a private registry.

          • filter — required — (String)

            The filter to use when scanning.

          • filterType — required — (String)

            The type associated with the filter.

            Possible values include:
            • "WILDCARD"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example obtains the repository policy for the repository named ubuntu. */

 var params = {
  repositoryName: "ubuntu"
 };
 ecr.getRepositoryPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
   }
   */
 });

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.getRepositoryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository with the policy to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.initiateLayerUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

/* This example lists all of the images in the repository named ubuntu in the default registry in the current account.  */

 var params = {
  repositoryName: "ubuntu"
 };
 ecr.listImages(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    imageIds: [
       {
      imageDigest: "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a", 
      imageTag: "precise"
     }
    ]
   }
   */
 });

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  filter: {
    tagStatus: TAGGED | UNTAGGED | ANY
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.listImages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

    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 — (map)

    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.

      Possible values include:
      • "TAGGED"
      • "UNTAGGED"
      • "ANY"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • imageIds — (Array<map>)

      The list of image IDs for the requested repository.

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ecr.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (Array<map>)

      The tags for the resource.

      • Key — required — (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 — required — (String)

        A value acts as a descriptor within a tag category (key).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  value: 'STRING_VALUE' /* required */
};
ecr.putAccountSetting(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    Basic scan type version name.

  • value — (String)

    Setting value that determines what basic scan type is being used: AWS_NATIVE or CLAIR.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • name — (String)

      Retrieves the the basic scan type version name.

    • value — (String)

      Retrieves the basic scan type value, either AWS_NATIVE or -.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageManifest: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  imageDigest: 'STRING_VALUE',
  imageManifestMediaType: 'STRING_VALUE',
  imageTag: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.putImage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • imageManifest — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • image — (map)

      Details of the image uploaded.

      • registryId — (String)

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

      • repositoryName — (String)

        The name of the repository associated with the image.

      • imageId — (map)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageScanningConfiguration: { /* required */
    scanOnPush: true || false
  },
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.putImageScanningConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • imageScanningConfiguration — (map)

    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 API_StartImageScan API.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryName — (String)

      The repository name associated with the request.

    • imageScanningConfiguration — (map)

      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 API_StartImageScan API.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageTagMutability: MUTABLE | IMMUTABLE, /* required */
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.putImageTagMutability(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • imageTagMutability — (String)

    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.

    Possible values include:
    • "MUTABLE"
    • "IMMUTABLE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "MUTABLE"
      • "IMMUTABLE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  lifecyclePolicyText: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.putLifecyclePolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository to receive the policy.

  • lifecyclePolicyText — (String)

    The JSON repository policy text to apply to the repository.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyText: 'STRING_VALUE' /* required */
};
ecr.putRegistryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • policyText — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • policyText — (String)

      The JSON policy text for your registry.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  rules: [
    {
      repositoryFilters: [ /* required */
        {
          filter: 'STRING_VALUE', /* required */
          filterType: WILDCARD /* required */
        },
        /* more items */
      ],
      scanFrequency: SCAN_ON_PUSH | CONTINUOUS_SCAN | MANUAL /* required */
    },
    /* more items */
  ],
  scanType: BASIC | ENHANCED
};
ecr.putRegistryScanningConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • scanType — (String)

    The scanning type to set for the registry.

    When a registry scanning configuration is not defined, by default the BASIC scan type is used. When basic scanning is used, you may specify filters to determine which individual repositories, or all repositories, are scanned when new images are pushed to those repositories. Alternatively, you can do manual scans of images with basic scanning.

    When the ENHANCED scan type is set, Amazon Inspector provides automated vulnerability scanning. You may choose between continuous scanning or scan on push and you may specify filters to determine which individual repositories, or all repositories, are scanned.

    Possible values include:
    • "BASIC"
    • "ENHANCED"
  • rules — (Array<map>)

    The scanning rules to use for the registry. A scanning rule is used to determine which repository filters are used and at what frequency scanning will occur.

    • scanFrequency — required — (String)

      The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

      Possible values include:
      • "SCAN_ON_PUSH"
      • "CONTINUOUS_SCAN"
      • "MANUAL"
    • repositoryFilters — required — (Array<map>)

      The repository filters associated with the scanning configuration for a private registry.

      • filter — required — (String)

        The filter to use when scanning.

      • filterType — required — (String)

        The type associated with the filter.

        Possible values include:
        • "WILDCARD"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryScanningConfiguration — (map)

      The scanning configuration for your registry.

      • scanType — (String)

        The type of scanning configured for the registry.

        Possible values include:
        • "BASIC"
        • "ENHANCED"
      • rules — (Array<map>)

        The scanning rules associated with the registry.

        • scanFrequency — required — (String)

          The frequency that scans are performed at for a private registry. When the ENHANCED scan type is specified, the supported scan frequencies are CONTINUOUS_SCAN and SCAN_ON_PUSH. When the BASIC scan type is specified, the SCAN_ON_PUSH scan frequency is supported. If scan on push is not specified, then the MANUAL scan frequency is set by default.

          Possible values include:
          • "SCAN_ON_PUSH"
          • "CONTINUOUS_SCAN"
          • "MANUAL"
        • repositoryFilters — required — (Array<map>)

          The repository filters associated with the scanning configuration for a private registry.

          • filter — required — (String)

            The filter to use when scanning.

          • filterType — required — (String)

            The type associated with the filter.

            Possible values include:
            • "WILDCARD"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  replicationConfiguration: { /* required */
    rules: [ /* required */
      {
        destinations: [ /* required */
          {
            region: 'STRING_VALUE', /* required */
            registryId: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        repositoryFilters: [
          {
            filter: 'STRING_VALUE', /* required */
            filterType: PREFIX_MATCH /* required */
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  }
};
ecr.putReplicationConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • replicationConfiguration — (map)

    An object representing the replication configuration for a registry.

    • rules — required — (Array<map>)

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

      • destinations — required — (Array<map>)

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

        • region — required — (String)

          The Region to replicate to.

        • registryId — required — (String)

          The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

      • repositoryFilters — (Array<map>)

        An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

        • filter — required — (String)

          The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

        • filterType — required — (String)

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

          Possible values include:
          • "PREFIX_MATCH"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • replicationConfiguration — (map)

      The contents of the replication configuration for the registry.

      • rules — required — (Array<map>)

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

        • destinations — required — (Array<map>)

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

          • region — required — (String)

            The Region to replicate to.

          • registryId — required — (String)

            The Amazon Web Services account ID of the Amazon ECR private registry to replicate to. When configuring cross-Region replication within your own registry, specify your own account ID.

        • repositoryFilters — (Array<map>)

          An array of objects representing the filters for a replication rule. Specifying a repository filter for a replication rule provides a method for controlling which repositories in a private registry are replicated.

          • filter — required — (String)

            The repository filter details. When the PREFIX_MATCH filter type is specified, this value is required and should be the repository name prefix to configure replication for.

          • filterType — required — (String)

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

            Possible values include:
            • "PREFIX_MATCH"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  policyText: 'STRING_VALUE', /* required */
  repositoryName: 'STRING_VALUE', /* required */
  force: true || false,
  registryId: 'STRING_VALUE'
};
ecr.setRepositoryPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    The name of the repository to receive the policy.

  • policyText — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  imageId: { /* required */
    imageDigest: 'STRING_VALUE',
    imageTag: 'STRING_VALUE'
  },
  repositoryName: 'STRING_VALUE', /* required */
  registryId: 'STRING_VALUE'
};
ecr.startImageScan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

    The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.

  • repositoryName — (String)

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

  • imageId — (map)

    An object with identifying information for an image in an Amazon ECR repository.

    • imageDigest — (String)

      The sha256 digest of the image manifest.

    • imageTag — (String)

      The tag used for the image.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • registryId — (String)

      The registry ID associated with the request.

    • repositoryName — (String)

      The repository name associated with the request.

    • imageId — (map)

      An object with identifying information for an image in an Amazon ECR repository.

      • imageDigest — (String)

        The sha256 digest of the image manifest.

      • imageTag — (String)

        The tag used for the image.

    • imageScanStatus — (map)

      The current state of the scan.

      • status — (String)

        The current state of an image scan.

        Possible values include:
        • "IN_PROGRESS"
        • "COMPLETE"
        • "FAILED"
        • "UNSUPPORTED_IMAGE"
        • "ACTIVE"
        • "PENDING"
        • "SCAN_ELIGIBILITY_EXPIRED"
        • "FINDINGS_UNAVAILABLE"
      • description — (String)

        The description of the image scan status.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  repositoryName: 'STRING_VALUE', /* required */
  lifecyclePolicyText: 'STRING_VALUE',
  registryId: 'STRING_VALUE'
};
ecr.startLifecyclePolicyPreview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • registryId — (String)

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

  • repositoryName — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "IN_PROGRESS"
      • "COMPLETE"
      • "EXPIRED"
      • "FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.