We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Imagebuilder

Inherits:
AWS.Service show all
Identifier:
imagebuilder
API Version:
2019-12-02
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

EC2 Image Builder is a fully managed Amazon Web Services service that makes it easier to automate the creation, management, and deployment of customized, secure, and up-to-date "golden" server images that are pre-installed and pre-configured with software and settings to meet specific IT standards.

Sending a Request Using Imagebuilder

var imagebuilder = new AWS.Imagebuilder();
imagebuilder.cancelImageCreation(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Imagebuilder object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var imagebuilder = new AWS.Imagebuilder({apiVersion: '2019-12-02'});

You can also set the API version globally in AWS.config.apiVersions using the imagebuilder service identifier:

AWS.config.apiVersions = {
  imagebuilder: '2019-12-02',
  // other service API versions
};

var imagebuilder = new AWS.Imagebuilder();

Version:

  • 2019-12-02

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Imagebuilder(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Imagebuilder object

var imagebuilder = new AWS.Imagebuilder({apiVersion: '2019-12-02'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Imagebuilder.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Imagebuilder.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Imagebuilder.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelImageCreation(params = {}, callback) ⇒ AWS.Request

CancelImageCreation cancels the creation of Image. This operation can only be used on images in a non-terminal state.

Service Reference:

Examples:

Calling the cancelImageCreation operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imageBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.cancelImageCreation(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: {})
    • imageBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the image that you want to cancel creation for.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imageBuildVersionArn — (String)

        The ARN of the image whose creation this request canceled.

Returns:

  • (AWS.Request)

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

cancelLifecycleExecution(params = {}, callback) ⇒ AWS.Request

Cancel a specific image lifecycle policy runtime instance.

Service Reference:

Examples:

Calling the cancelLifecycleExecution operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  lifecycleExecutionId: 'STRING_VALUE' /* required */
};
imagebuilder.cancelLifecycleExecution(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: {})
    • lifecycleExecutionId — (String)

      Identifies the specific runtime instance of the image lifecycle to cancel.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • lifecycleExecutionId — (String)

        The unique identifier for the image lifecycle runtime instance that was canceled.

Returns:

  • (AWS.Request)

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

createComponent(params = {}, callback) ⇒ AWS.Request

Creates a new component that can be used to build, validate, test, and assess your image. The component is based on a YAML document that you specify using exactly one of the following methods:

  • Inline, using the data property in the request body.

  • A URL that points to a YAML document file stored in Amazon S3, using the uri property in the request body.

Service Reference:

Examples:

Calling the createComponent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  platform: Windows | Linux, /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  changeDescription: 'STRING_VALUE',
  data: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  supportedOsVersions: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  uri: 'STRING_VALUE'
};
imagebuilder.createComponent(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)

      The name of the component.

    • semanticVersion — (String)

      The semantic version of the component. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • description — (String)

      Describes the contents of the component.

    • changeDescription — (String)

      The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.

    • platform — (String)

      The operating system platform of the component.

      Possible values include:
      • "Windows"
      • "Linux"
    • supportedOsVersions — (Array<String>)

      The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

    • data — (String)

      Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

    • uri — (String)

      The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

      Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

    • kmsKeyId — (String)

      The ID of the KMS key that is used to encrypt this component.

    • tags — (map<String>)

      The tags that apply to the component.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • componentBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the component that the request created.

Returns:

  • (AWS.Request)

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

createContainerRecipe(params = {}, callback) ⇒ AWS.Request

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Service Reference:

Examples:

Calling the createContainerRecipe operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  components: [ /* required */
    {
      componentArn: 'STRING_VALUE', /* required */
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  containerType: DOCKER, /* required */
  name: 'STRING_VALUE', /* required */
  parentImage: 'STRING_VALUE', /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  targetRepository: { /* required */
    repositoryName: 'STRING_VALUE', /* required */
    service: ECR /* required */
  },
  description: 'STRING_VALUE',
  dockerfileTemplateData: 'STRING_VALUE',
  dockerfileTemplateUri: 'STRING_VALUE',
  imageOsVersionOverride: 'STRING_VALUE',
  instanceConfiguration: {
    blockDeviceMappings: [
      {
        deviceName: 'STRING_VALUE',
        ebs: {
          deleteOnTermination: true || false,
          encrypted: true || false,
          iops: 'NUMBER_VALUE',
          kmsKeyId: 'STRING_VALUE',
          snapshotId: 'STRING_VALUE',
          throughput: 'NUMBER_VALUE',
          volumeSize: 'NUMBER_VALUE',
          volumeType: standard | io1 | io2 | gp2 | gp3 | sc1 | st1
        },
        noDevice: 'STRING_VALUE',
        virtualName: 'STRING_VALUE'
      },
      /* more items */
    ],
    image: 'STRING_VALUE'
  },
  kmsKeyId: 'STRING_VALUE',
  platformOverride: Windows | Linux,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workingDirectory: 'STRING_VALUE'
};
imagebuilder.createContainerRecipe(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: {})
    • containerType — (String)

      The type of container to create.

      Possible values include:
      • "DOCKER"
    • name — (String)

      The name of the container recipe.

    • description — (String)

      The description of the container recipe.

    • semanticVersion — (String)

      The semantic version of the container recipe. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • components — (Array<map>)

      Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

      • componentArnrequired — (String)

        The Amazon Resource Name (ARN) of the component.

      • parameters — (Array<map>)

        A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

        • namerequired — (String)

          The name of the component parameter to set.

        • valuerequired — (Array<String>)

          Sets the value for the named component parameter.

    • instanceConfiguration — (map)

      A group of options that can be used to configure an instance for building and testing container images.

      • image — (String)

        The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

      • blockDeviceMappings — (Array<map>)

        Defines the block devices to attach for building an instance from this Image Builder AMI.

        • deviceName — (String)

          The device to which these mappings apply.

        • ebs — (map)

          Use to manage Amazon EBS-specific configuration for this mapping.

          • encrypted — (Boolean)

            Use to configure device encryption.

          • deleteOnTermination — (Boolean)

            Use to configure delete on termination of the associated device.

          • iops — (Integer)

            Use to configure device IOPS.

          • kmsKeyId — (String)

            Use to configure the KMS key to use when encrypting the device.

          • snapshotId — (String)

            The snapshot that defines the device contents.

          • volumeSize — (Integer)

            Use to override the device's volume size.

          • volumeType — (String)

            Use to override the device's volume type.

            Possible values include:
            • "standard"
            • "io1"
            • "io2"
            • "gp2"
            • "gp3"
            • "sc1"
            • "st1"
          • throughput — (Integer)

            For GP3 volumes only – The throughput in MiB/s that the volume supports.

        • virtualName — (String)

          Use to manage instance ephemeral devices.

        • noDevice — (String)

          Use to remove a mapping from the base image.

    • dockerfileTemplateData — (String)

      The Dockerfile template used to build your image as an inline data blob.

    • dockerfileTemplateUri — (String)

      The Amazon S3 URI for the Dockerfile that will be used to build your container image.

    • platformOverride — (String)

      Specifies the operating system platform when you use a custom base image.

      Possible values include:
      • "Windows"
      • "Linux"
    • imageOsVersionOverride — (String)

      Specifies the operating system version for the base image.

    • parentImage — (String)

      The base image for the container recipe.

    • tags — (map<String>)

      Tags that are attached to the container recipe.

    • workingDirectory — (String)

      The working directory for use during build and test workflows.

    • targetRepository — (map)

      The destination repository for the container image.

      • servicerequired — (String)

        Specifies the service in which this image was registered.

        Possible values include:
        • "ECR"
      • repositoryNamerequired — (String)

        The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

    • kmsKeyId — (String)

      Identifies which KMS key is used to encrypt the container image.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • containerRecipeArn — (String)

        Returns the Amazon Resource Name (ARN) of the container recipe that the request created.

Returns:

  • (AWS.Request)

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

createDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Service Reference:

Examples:

Calling the createDistributionConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  distributions: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      amiDistributionConfiguration: {
        amiTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        description: 'STRING_VALUE',
        kmsKeyId: 'STRING_VALUE',
        launchPermission: {
          organizationArns: [
            'STRING_VALUE',
            /* more items */
          ],
          organizationalUnitArns: [
            'STRING_VALUE',
            /* more items */
          ],
          userGroups: [
            'STRING_VALUE',
            /* more items */
          ],
          userIds: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        name: 'STRING_VALUE',
        targetAccountIds: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      containerDistributionConfiguration: {
        targetRepository: { /* required */
          repositoryName: 'STRING_VALUE', /* required */
          service: ECR /* required */
        },
        containerTags: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE'
      },
      fastLaunchConfigurations: [
        {
          enabled: true || false, /* required */
          accountId: 'STRING_VALUE',
          launchTemplate: {
            launchTemplateId: 'STRING_VALUE',
            launchTemplateName: 'STRING_VALUE',
            launchTemplateVersion: 'STRING_VALUE'
          },
          maxParallelLaunches: 'NUMBER_VALUE',
          snapshotConfiguration: {
            targetResourceCount: 'NUMBER_VALUE'
          }
        },
        /* more items */
      ],
      launchTemplateConfigurations: [
        {
          launchTemplateId: 'STRING_VALUE', /* required */
          accountId: 'STRING_VALUE',
          setDefaultVersion: true || false
        },
        /* more items */
      ],
      licenseConfigurationArns: [
        'STRING_VALUE',
        /* more items */
      ],
      s3ExportConfiguration: {
        diskImageFormat: VMDK | RAW | VHD, /* required */
        roleName: 'STRING_VALUE', /* required */
        s3Bucket: 'STRING_VALUE', /* required */
        s3Prefix: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.createDistributionConfiguration(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)

      The name of the distribution configuration.

    • description — (String)

      The description of the distribution configuration.

    • distributions — (Array<map>)

      The distributions of the distribution configuration.

      • regionrequired — (String)

        The target Region.

      • amiDistributionConfiguration — (map)

        The specific AMI settings; for example, launch permissions or AMI tags.

        • name — (String)

          The name of the output AMI.

        • description — (String)

          The description of the AMI distribution configuration. Minimum and maximum length are in characters.

        • targetAccountIds — (Array<String>)

          The ID of an account to which you want to distribute an image.

        • amiTags — (map<String>)

          The tags to apply to AMIs distributed to this Region.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the distributed image.

        • launchPermission — (map)

          Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

          • userIds — (Array<String>)

            The Amazon Web Services account ID.

          • userGroups — (Array<String>)

            The name of the group.

          • organizationArns — (Array<String>)

            The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

          • organizationalUnitArns — (Array<String>)

            The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

      • containerDistributionConfiguration — (map)

        Container distribution settings for encryption, licensing, and sharing in a specific Region.

        • description — (String)

          The description of the container distribution configuration.

        • containerTags — (Array<String>)

          Tags that are attached to the container distribution configuration.

        • targetRepositoryrequired — (map)

          The destination repository for the container distribution configuration.

          • servicerequired — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryNamerequired — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

      • licenseConfigurationArns — (Array<String>)

        The License Manager Configuration to associate with the AMI in the specified Region.

      • launchTemplateConfigurations — (Array<map>)

        A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

        • launchTemplateIdrequired — (String)

          Identifies the Amazon EC2 launch template to use.

        • accountId — (String)

          The account ID that this configuration applies to.

        • setDefaultVersion — (Boolean)

          Set the specified Amazon EC2 launch template as the default launch template for the specified account.

      • s3ExportConfiguration — (map)

        Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

        • roleNamerequired — (String)

          The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

        • diskImageFormatrequired — (String)

          Export the updated image to one of the following supported disk image formats:

          • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

          • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

          • Raw – Raw format.

          Possible values include:
          • "VMDK"
          • "RAW"
          • "VHD"
        • s3Bucketrequired — (String)

          The S3 bucket in which to store the output disk images for your VM.

        • s3Prefix — (String)

          The Amazon S3 path for the bucket where the output disk images for your VM are stored.

      • fastLaunchConfigurations — (Array<map>)

        The Windows faster-launching configurations to use for AMI distribution.

        • enabledrequired — (Boolean)

          A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

        • snapshotConfiguration — (map)

          Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

          • targetResourceCount — (Integer)

            The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

        • maxParallelLaunches — (Integer)

          The maximum number of parallel instances that are launched for creating resources.

        • launchTemplate — (map)

          The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

          • launchTemplateId — (String)

            The ID of the launch template to use for faster launching for a Windows AMI.

          • launchTemplateName — (String)

            The name of the launch template to use for faster launching for a Windows AMI.

          • launchTemplateVersion — (String)

            The version of the launch template to use for faster launching for a Windows AMI.

        • accountId — (String)

          The owner account ID for the fast-launch enabled Windows AMI.

    • tags — (map<String>)

      The tags of the distribution configuration.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.

Returns:

  • (AWS.Request)

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

createImage(params = {}, callback) ⇒ AWS.Request

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Service Reference:

Examples:

Calling the createImage operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  executionRole: 'STRING_VALUE',
  imageRecipeArn: 'STRING_VALUE',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: [
        'STRING_VALUE',
        /* more items */
      ],
      repositoryName: 'STRING_VALUE'
    },
    imageScanningEnabled: true || false
  },
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workflows: [
    {
      workflowArn: 'STRING_VALUE', /* required */
      onFailure: CONTINUE | ABORT,
      parallelGroup: 'STRING_VALUE',
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
imagebuilder.createImage(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: {})
    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

    • imageTestsConfiguration — (map)

      The image tests configuration of the image.

      • imageTestsEnabled — (Boolean)

        Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

        Note: The timeoutMinutes attribute is not currently active. This value is ignored.
    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • tags — (map<String>)

      The tags of the image.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.
    • imageScanningConfiguration — (map)

      Contains settings for vulnerability scans.

      • imageScanningEnabled — (Boolean)

        A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

      • ecrConfiguration — (map)

        Contains Amazon ECR settings for vulnerability scans.

        • repositoryName — (String)

          The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

        • containerTags — (Array<String>)

          Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

    • workflows — (Array<map>)

      Contains an array of workflow configuration objects.

      • workflowArnrequired — (String)

        The Amazon Resource Name (ARN) of the workflow resource.

      • parameters — (Array<map>)

        Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

        • namerequired — (String)

          The name of the workflow parameter to set.

        • valuerequired — (Array<String>)

          Sets the value for the named workflow parameter.

      • parallelGroup — (String)

        Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

      • onFailure — (String)

        The action to take if the workflow fails.

        Possible values include:
        • "CONTINUE"
        • "ABORT"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image that the request created.

Returns:

  • (AWS.Request)

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

createImagePipeline(params = {}, callback) ⇒ AWS.Request

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Service Reference:

Examples:

Calling the createImagePipeline operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  executionRole: 'STRING_VALUE',
  imageRecipeArn: 'STRING_VALUE',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: [
        'STRING_VALUE',
        /* more items */
      ],
      repositoryName: 'STRING_VALUE'
    },
    imageScanningEnabled: true || false
  },
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  schedule: {
    pipelineExecutionStartCondition: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
    scheduleExpression: 'STRING_VALUE',
    timezone: 'STRING_VALUE'
  },
  status: DISABLED | ENABLED,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workflows: [
    {
      workflowArn: 'STRING_VALUE', /* required */
      onFailure: CONTINUE | ABORT,
      parallelGroup: 'STRING_VALUE',
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
imagebuilder.createImagePipeline(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)

      The name of the image pipeline.

    • description — (String)

      The description of the image pipeline.

    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

    • imageTestsConfiguration — (map)

      The image test configuration of the image pipeline.

      • imageTestsEnabled — (Boolean)

        Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

        Note: The timeoutMinutes attribute is not currently active. This value is ignored.
    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • schedule — (map)

      The schedule of the image pipeline.

      • scheduleExpression — (String)

        The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

        For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

      • timezone — (String)

        The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

      • pipelineExecutionStartCondition — (String)

        The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

        Possible values include:
        • "EXPRESSION_MATCH_ONLY"
        • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    • status — (String)

      The status of the image pipeline.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • tags — (map<String>)

      The tags of the image pipeline.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.
    • imageScanningConfiguration — (map)

      Contains settings for vulnerability scans.

      • imageScanningEnabled — (Boolean)

        A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

      • ecrConfiguration — (map)

        Contains Amazon ECR settings for vulnerability scans.

        • repositoryName — (String)

          The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

        • containerTags — (Array<String>)

          Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

    • workflows — (Array<map>)

      Contains an array of workflow configuration objects.

      • workflowArnrequired — (String)

        The Amazon Resource Name (ARN) of the workflow resource.

      • parameters — (Array<map>)

        Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

        • namerequired — (String)

          The name of the workflow parameter to set.

        • valuerequired — (Array<String>)

          Sets the value for the named workflow parameter.

      • parallelGroup — (String)

        Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

      • onFailure — (String)

        The action to take if the workflow fails.

        Possible values include:
        • "CONTINUE"
        • "ABORT"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

Returns:

  • (AWS.Request)

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

createImageRecipe(params = {}, callback) ⇒ AWS.Request

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Service Reference:

Examples:

Calling the createImageRecipe operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  components: [ /* required */
    {
      componentArn: 'STRING_VALUE', /* required */
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  name: 'STRING_VALUE', /* required */
  parentImage: 'STRING_VALUE', /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  additionalInstanceConfiguration: {
    systemsManagerAgent: {
      uninstallAfterBuild: true || false
    },
    userDataOverride: 'STRING_VALUE'
  },
  blockDeviceMappings: [
    {
      deviceName: 'STRING_VALUE',
      ebs: {
        deleteOnTermination: true || false,
        encrypted: true || false,
        iops: 'NUMBER_VALUE',
        kmsKeyId: 'STRING_VALUE',
        snapshotId: 'STRING_VALUE',
        throughput: 'NUMBER_VALUE',
        volumeSize: 'NUMBER_VALUE',
        volumeType: standard | io1 | io2 | gp2 | gp3 | sc1 | st1
      },
      noDevice: 'STRING_VALUE',
      virtualName: 'STRING_VALUE'
    },
    /* more items */
  ],
  description: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workingDirectory: 'STRING_VALUE'
};
imagebuilder.createImageRecipe(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)

      The name of the image recipe.

    • description — (String)

      The description of the image recipe.

    • semanticVersion — (String)

      The semantic version of the image recipe. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • components — (Array<map>)

      The components included in the image recipe.

      • componentArnrequired — (String)

        The Amazon Resource Name (ARN) of the component.

      • parameters — (Array<map>)

        A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

        • namerequired — (String)

          The name of the component parameter to set.

        • valuerequired — (Array<String>)

          Sets the value for the named component parameter.

    • parentImage — (String)

      The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

    • blockDeviceMappings — (Array<map>)

      The block device mappings of the image recipe.

      • deviceName — (String)

        The device to which these mappings apply.

      • ebs — (map)

        Use to manage Amazon EBS-specific configuration for this mapping.

        • encrypted — (Boolean)

          Use to configure device encryption.

        • deleteOnTermination — (Boolean)

          Use to configure delete on termination of the associated device.

        • iops — (Integer)

          Use to configure device IOPS.

        • kmsKeyId — (String)

          Use to configure the KMS key to use when encrypting the device.

        • snapshotId — (String)

          The snapshot that defines the device contents.

        • volumeSize — (Integer)

          Use to override the device's volume size.

        • volumeType — (String)

          Use to override the device's volume type.

          Possible values include:
          • "standard"
          • "io1"
          • "io2"
          • "gp2"
          • "gp3"
          • "sc1"
          • "st1"
        • throughput — (Integer)

          For GP3 volumes only – The throughput in MiB/s that the volume supports.

      • virtualName — (String)

        Use to manage instance ephemeral devices.

      • noDevice — (String)

        Use to remove a mapping from the base image.

    • tags — (map<String>)

      The tags of the image recipe.

    • workingDirectory — (String)

      The working directory used during build and test workflows.

    • additionalInstanceConfiguration — (map)

      Specify additional settings and launch scripts for your build instances.

      • systemsManagerAgent — (map)

        Contains settings for the Systems Manager agent on your build instance.

        • uninstallAfterBuild — (Boolean)

          Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

      • userDataOverride — (String)

        Use this property to provide commands or a command script to run when you launch your build instance.

        The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

        Note: The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$: #!/bin/bash mkdir -p /var/bb/ touch /var
    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that was created by this request.

Returns:

  • (AWS.Request)

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

createInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Examples:

Calling the createInfrastructureConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  instanceProfileName: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  instanceMetadataOptions: {
    httpPutResponseHopLimit: 'NUMBER_VALUE',
    httpTokens: 'STRING_VALUE'
  },
  instanceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  keyPair: 'STRING_VALUE',
  logging: {
    s3Logs: {
      s3BucketName: 'STRING_VALUE',
      s3KeyPrefix: 'STRING_VALUE'
    }
  },
  resourceTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  snsTopicArn: 'STRING_VALUE',
  subnetId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  terminateInstanceOnFailure: true || false
};
imagebuilder.createInfrastructureConfiguration(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)

      The name of the infrastructure configuration.

    • description — (String)

      The description of the infrastructure configuration.

    • instanceTypes — (Array<String>)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

    • instanceProfileName — (String)

      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • securityGroupIds — (Array<String>)

      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • subnetId — (String)

      The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

    • logging — (map)

      The logging configuration of the infrastructure configuration.

      • s3Logs — (map)

        The Amazon S3 logging configuration.

        • s3BucketName — (String)

          The S3 bucket in which to store the logs.

        • s3KeyPrefix — (String)

          The Amazon S3 path to the bucket where the logs are stored.

    • keyPair — (String)

      The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

    • terminateInstanceOnFailure — (Boolean)

      The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

    • snsTopicArn — (String)

      The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

      Note: EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
    • resourceTags — (map<String>)

      The tags attached to the resource created by Image Builder.

    • instanceMetadataOptions — (map)

      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

      • httpTokens — (String)

        Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

        • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

        • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

        The default setting is optional.

      • httpPutResponseHopLimit — (Integer)

        Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

    • tags — (map<String>)

      The tags of the infrastructure configuration.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

Returns:

  • (AWS.Request)

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

createLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Create a lifecycle policy resource.

Service Reference:

Examples:

Calling the createLifecyclePolicy operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  executionRole: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  policyDetails: [ /* required */
    {
      action: { /* required */
        type: DELETE | DEPRECATE | DISABLE, /* required */
        includeResources: {
          amis: true || false,
          containers: true || false,
          snapshots: true || false
        }
      },
      filter: { /* required */
        type: AGE | COUNT, /* required */
        value: 'NUMBER_VALUE', /* required */
        retainAtLeast: 'NUMBER_VALUE',
        unit: DAYS | WEEKS | MONTHS | YEARS
      },
      exclusionRules: {
        amis: {
          isPublic: true || false,
          lastLaunched: {
            unit: DAYS | WEEKS | MONTHS | YEARS, /* required */
            value: 'NUMBER_VALUE' /* required */
          },
          regions: [
            'STRING_VALUE',
            /* more items */
          ],
          sharedAccounts: [
            'STRING_VALUE',
            /* more items */
          ],
          tagMap: {
            '<TagKey>': 'STRING_VALUE',
            /* '<TagKey>': ... */
          }
        },
        tagMap: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        }
      }
    },
    /* more items */
  ],
  resourceSelection: { /* required */
    recipes: [
      {
        name: 'STRING_VALUE', /* required */
        semanticVersion: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    tagMap: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  resourceType: AMI_IMAGE | CONTAINER_IMAGE, /* required */
  description: 'STRING_VALUE',
  status: DISABLED | ENABLED,
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.createLifecyclePolicy(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)

      The name of the lifecycle policy to create.

    • description — (String)

      Optional description for the lifecycle policy.

    • status — (String)

      Indicates whether the lifecycle policy resource is enabled.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.

    • resourceType — (String)

      The type of Image Builder resource that the lifecycle policy applies to.

      Possible values include:
      • "AMI_IMAGE"
      • "CONTAINER_IMAGE"
    • policyDetails — (Array<map>)

      Configuration details for the lifecycle policy rules.

      • actionrequired — (map)

        Configuration details for the policy action.

        • typerequired — (String)

          Specifies the lifecycle action to take.

          Possible values include:
          • "DELETE"
          • "DEPRECATE"
          • "DISABLE"
        • includeResources — (map)

          Specifies the resources that the lifecycle policy applies to.

          • amis — (Boolean)

            Specifies whether the lifecycle action should apply to distributed AMIs.

          • snapshots — (Boolean)

            Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

          • containers — (Boolean)

            Specifies whether the lifecycle action should apply to distributed containers.

      • filterrequired — (map)

        Specifies the resources that the lifecycle policy applies to.

        • typerequired — (String)

          Filter resources based on either age or count.

          Possible values include:
          • "AGE"
          • "COUNT"
        • valuerequired — (Integer)

          The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.

          Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
        • unit — (String)

          Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.

          Possible values include:
          • "DAYS"
          • "WEEKS"
          • "MONTHS"
          • "YEARS"
        • retainAtLeast — (Integer)

          For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

      • exclusionRules — (map)

        Additional rules to specify resources that should be exempt from policy actions.

        • tagMap — (map<String>)

          Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

        • amis — (map)

          Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

          • isPublic — (Boolean)

            Configures whether public AMIs are excluded from the lifecycle action.

          • regions — (Array<String>)

            Configures Amazon Web Services Regions that are excluded from the lifecycle action.

          • sharedAccounts — (Array<String>)

            Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.

          • lastLaunched — (map)

            Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

            • valuerequired — (Integer)

              The integer number of units for the time period. For example 6 (months).

            • unitrequired — (String)

              Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.

              Possible values include:
              • "DAYS"
              • "WEEKS"
              • "MONTHS"
              • "YEARS"
          • tagMap — (map<String>)

            Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

    • resourceSelection — (map)

      Selection criteria for the resources that the lifecycle policy applies to.

      • recipes — (Array<map>)

        A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

        • namerequired — (String)

          The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

        • semanticVersionrequired — (String)

          The version of the Image Builder recipe specified by the name field.

      • tagMap — (map<String>)

        A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

    • tags — (map<String>)

      Tags to apply to the lifecycle policy resource.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • lifecyclePolicyArn — (String)

        The Amazon Resource Name (ARN) of the lifecycle policy that the request created.

Returns:

  • (AWS.Request)

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

createWorkflow(params = {}, callback) ⇒ AWS.Request

Create a new workflow or a new version of an existing workflow.

Service Reference:

Examples:

Calling the createWorkflow operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  type: BUILD | TEST | DISTRIBUTION, /* required */
  changeDescription: 'STRING_VALUE',
  data: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  uri: 'STRING_VALUE'
};
imagebuilder.createWorkflow(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)

      The name of the workflow to create.

    • semanticVersion — (String)

      The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • description — (String)

      Describes the workflow.

    • changeDescription — (String)

      Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

    • data — (String)

      Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

    • uri — (String)

      The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

      Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

    • kmsKeyId — (String)

      The ID of the KMS key that is used to encrypt this workflow resource.

    • tags — (map<String>)

      Tags that apply to the workflow resource.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.
    • type — (String)

      The phase in the image build process for which the workflow resource is responsible.

      Possible values include:
      • "BUILD"
      • "TEST"
      • "DISTRIBUTION"

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:

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • workflowBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the workflow resource that the request created.

Returns:

  • (AWS.Request)

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

deleteComponent(params = {}, callback) ⇒ AWS.Request

Deletes a component build version.

Service Reference:

Examples:

Calling the deleteComponent operation

var params = {
  componentBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteComponent(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: {})
    • componentBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the component build version 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentBuildVersionArn — (String)

        The ARN of the component build version that this request deleted.

Returns:

  • (AWS.Request)

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

deleteContainerRecipe(params = {}, callback) ⇒ AWS.Request

Deletes a container recipe.

Service Reference:

Examples:

Calling the deleteContainerRecipe operation

var params = {
  containerRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteContainerRecipe(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: {})
    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeArn — (String)

        The Amazon Resource Name (ARN) of the container recipe that was deleted.

Returns:

  • (AWS.Request)

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

deleteDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a distribution configuration.

Service Reference:

Examples:

Calling the deleteDistributionConfiguration operation

var params = {
  distributionConfigurationArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteDistributionConfiguration(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: {})
    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was deleted.

Returns:

  • (AWS.Request)

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

deleteImage(params = {}, callback) ⇒ AWS.Request

Deletes an Image Builder image resource. This does not delete any EC2 AMIs or ECR container images that are created during the image build process. You must clean those up separately, using the appropriate Amazon EC2 or Amazon ECR console actions, or API or CLI commands.

Service Reference:

Examples:

Calling the deleteImage operation

var params = {
  imageBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteImage(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: {})
    • imageBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the Image Builder image resource 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageBuildVersionArn — (String)

        The ARN of the Image Builder image resource that this request deleted.

Returns:

  • (AWS.Request)

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

deleteImagePipeline(params = {}, callback) ⇒ AWS.Request

Deletes an image pipeline.

Service Reference:

Examples:

Calling the deleteImagePipeline operation

var params = {
  imagePipelineArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteImagePipeline(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: {})
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was deleted.

Returns:

  • (AWS.Request)

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

deleteImageRecipe(params = {}, callback) ⇒ AWS.Request

Deletes an image recipe.

Service Reference:

Examples:

Calling the deleteImageRecipe operation

var params = {
  imageRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteImageRecipe(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: {})
    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that was deleted.

Returns:

  • (AWS.Request)

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

deleteInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes an infrastructure configuration.

Examples:

Calling the deleteInfrastructureConfiguration operation

var params = {
  infrastructureConfigurationArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteInfrastructureConfiguration(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: {})
    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.

Returns:

  • (AWS.Request)

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

deleteLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Delete the specified lifecycle policy resource.

Service Reference:

Examples:

Calling the deleteLifecyclePolicy operation

var params = {
  lifecyclePolicyArn: 'STRING_VALUE' /* required */
};
imagebuilder.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: {})
    • lifecyclePolicyArn — (String)

      The Amazon Resource Name (ARN) of the lifecycle policy resource 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:

      • lifecyclePolicyArn — (String)

        The ARN of the lifecycle policy that was deleted.

Returns:

  • (AWS.Request)

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

deleteWorkflow(params = {}, callback) ⇒ AWS.Request

Deletes a specific workflow resource.

Service Reference:

Examples:

Calling the deleteWorkflow operation

var params = {
  workflowBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.deleteWorkflow(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: {})
    • workflowBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the workflow resource 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:

      • workflowBuildVersionArn — (String)

        The ARN of the workflow resource that this request deleted.

Returns:

  • (AWS.Request)

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

getComponent(params = {}, callback) ⇒ AWS.Request

Gets a component object.

Service Reference:

Examples:

Calling the getComponent operation

var params = {
  componentBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.getComponent(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: {})
    • componentBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the component that you want to get. Regex requires the suffix /\d+$.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • component — (map)

        The component object specified in the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

        • name — (String)

          The name of the component.

        • version — (String)

          The version of the component.

        • description — (String)

          The description of the component.

        • changeDescription — (String)

          Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

        • type — (String)

          The component type specifies whether Image Builder uses the component to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • platform — (String)

          The operating system platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

        • state — (map)

          Describes the current status of the component. This is used for components that are no longer active.

          • status — (String)

            The current state of the component.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the component changed state.

        • parameters — (Array<map>)

          Contains parameter details for each of the parameters that the component document defined for the component.

          • namerequired — (String)

            The name of this input parameter.

          • typerequired — (String)

            The type of input this parameter provides. The currently supported value is "string".

          • defaultValue — (Array<String>)

            The default value of this parameter if no input is provided.

          • description — (String)

            Describes this parameter.

        • owner — (String)

          The owner of the component.

        • data — (String)

          Component data contains the YAML document content for the component.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the component.

        • encrypted — (Boolean)

          The encryption status of the component.

        • dateCreated — (String)

          The date that Image Builder created the component.

        • tags — (map<String>)

          The tags that apply to the component.

        • publisher — (String)

          Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

        • obfuscate — (Boolean)

          Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Returns:

  • (AWS.Request)

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

getComponentPolicy(params = {}, callback) ⇒ AWS.Request

Gets a component policy.

Service Reference:

Examples:

Calling the getComponentPolicy operation

var params = {
  componentArn: 'STRING_VALUE' /* required */
};
imagebuilder.getComponentPolicy(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: {})
    • componentArn — (String)

      The Amazon Resource Name (ARN) of the component whose policy you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The component policy.

Returns:

  • (AWS.Request)

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

getContainerRecipe(params = {}, callback) ⇒ AWS.Request

Retrieves a container recipe.

Service Reference:

Examples:

Calling the getContainerRecipe operation

var params = {
  containerRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.getContainerRecipe(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: {})
    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipe — (map)

        The container recipe object that is returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the container recipe.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • containerType — (String)

          Specifies the type of container, such as Docker.

          Possible values include:
          • "DOCKER"
        • name — (String)

          The name of the container recipe.

        • description — (String)

          The description of the container recipe.

        • platform — (String)

          The system platform for the container, such as Windows or Linux.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the container recipe.

        • version — (String)

          The semantic version of the container recipe.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • components — (Array<map>)

          Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

          • componentArnrequired — (String)

            The Amazon Resource Name (ARN) of the component.

          • parameters — (Array<map>)

            A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

            • namerequired — (String)

              The name of the component parameter to set.

            • valuerequired — (Array<String>)

              Sets the value for the named component parameter.

        • instanceConfiguration — (map)

          A group of options that can be used to configure an instance for building and testing container images.

          • image — (String)

            The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

          • blockDeviceMappings — (Array<map>)

            Defines the block devices to attach for building an instance from this Image Builder AMI.

            • deviceName — (String)

              The device to which these mappings apply.

            • ebs — (map)

              Use to manage Amazon EBS-specific configuration for this mapping.

              • encrypted — (Boolean)

                Use to configure device encryption.

              • deleteOnTermination — (Boolean)

                Use to configure delete on termination of the associated device.

              • iops — (Integer)

                Use to configure device IOPS.

              • kmsKeyId — (String)

                Use to configure the KMS key to use when encrypting the device.

              • snapshotId — (String)

                The snapshot that defines the device contents.

              • volumeSize — (Integer)

                Use to override the device's volume size.

              • volumeType — (String)

                Use to override the device's volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "gp3"
                • "sc1"
                • "st1"
              • throughput — (Integer)

                For GP3 volumes only – The throughput in MiB/s that the volume supports.

            • virtualName — (String)

              Use to manage instance ephemeral devices.

            • noDevice — (String)

              Use to remove a mapping from the base image.

        • dockerfileTemplateData — (String)

          Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

        • kmsKeyId — (String)

          Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

        • encrypted — (Boolean)

          A flag that indicates if the target container is encrypted.

        • parentImage — (String)

          The base image for the container recipe.

        • dateCreated — (String)

          The date when this container recipe was created.

        • tags — (map<String>)

          Tags that are attached to the container recipe.

        • workingDirectory — (String)

          The working directory for use during build and test workflows.

        • targetRepository — (map)

          The destination repository for the container image.

          • servicerequired — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryNamerequired — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

Returns:

  • (AWS.Request)

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

getContainerRecipePolicy(params = {}, callback) ⇒ AWS.Request

Retrieves the policy for a container recipe.

Service Reference:

Examples:

Calling the getContainerRecipePolicy operation

var params = {
  containerRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.getContainerRecipePolicy(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: {})
    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe for the policy being requested.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The container recipe policy object that is returned.

Returns:

  • (AWS.Request)

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

getDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Gets a distribution configuration.

Service Reference:

Examples:

Calling the getDistributionConfiguration operation

var params = {
  distributionConfigurationArn: 'STRING_VALUE' /* required */
};
imagebuilder.getDistributionConfiguration(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: {})
    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfiguration — (map)

        The distribution configuration object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration.

        • name — (String)

          The name of the distribution configuration.

        • description — (String)

          The description of the distribution configuration.

        • distributions — (Array<map>)

          The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.

          • regionrequired — (String)

            The target Region.

          • amiDistributionConfiguration — (map)

            The specific AMI settings; for example, launch permissions or AMI tags.

            • name — (String)

              The name of the output AMI.

            • description — (String)

              The description of the AMI distribution configuration. Minimum and maximum length are in characters.

            • targetAccountIds — (Array<String>)

              The ID of an account to which you want to distribute an image.

            • amiTags — (map<String>)

              The tags to apply to AMIs distributed to this Region.

            • kmsKeyId — (String)

              The KMS key identifier used to encrypt the distributed image.

            • launchPermission — (map)

              Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

              • userIds — (Array<String>)

                The Amazon Web Services account ID.

              • userGroups — (Array<String>)

                The name of the group.

              • organizationArns — (Array<String>)

                The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

              • organizationalUnitArns — (Array<String>)

                The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

          • containerDistributionConfiguration — (map)

            Container distribution settings for encryption, licensing, and sharing in a specific Region.

            • description — (String)

              The description of the container distribution configuration.

            • containerTags — (Array<String>)

              Tags that are attached to the container distribution configuration.

            • targetRepositoryrequired — (map)

              The destination repository for the container distribution configuration.

              • servicerequired — (String)

                Specifies the service in which this image was registered.

                Possible values include:
                • "ECR"
              • repositoryNamerequired — (String)

                The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

          • licenseConfigurationArns — (Array<String>)

            The License Manager Configuration to associate with the AMI in the specified Region.

          • launchTemplateConfigurations — (Array<map>)

            A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

            • launchTemplateIdrequired — (String)

              Identifies the Amazon EC2 launch template to use.

            • accountId — (String)

              The account ID that this configuration applies to.

            • setDefaultVersion — (Boolean)

              Set the specified Amazon EC2 launch template as the default launch template for the specified account.

          • s3ExportConfiguration — (map)

            Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

            • roleNamerequired — (String)

              The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

            • diskImageFormatrequired — (String)

              Export the updated image to one of the following supported disk image formats:

              • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

              • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

              • Raw – Raw format.

              Possible values include:
              • "VMDK"
              • "RAW"
              • "VHD"
            • s3Bucketrequired — (String)

              The S3 bucket in which to store the output disk images for your VM.

            • s3Prefix — (String)

              The Amazon S3 path for the bucket where the output disk images for your VM are stored.

          • fastLaunchConfigurations — (Array<map>)

            The Windows faster-launching configurations to use for AMI distribution.

            • enabledrequired — (Boolean)

              A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

            • snapshotConfiguration — (map)

              Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

              • targetResourceCount — (Integer)

                The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

            • maxParallelLaunches — (Integer)

              The maximum number of parallel instances that are launched for creating resources.

            • launchTemplate — (map)

              The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

              • launchTemplateId — (String)

                The ID of the launch template to use for faster launching for a Windows AMI.

              • launchTemplateName — (String)

                The name of the launch template to use for faster launching for a Windows AMI.

              • launchTemplateVersion — (String)

                The version of the launch template to use for faster launching for a Windows AMI.

            • accountId — (String)

              The owner account ID for the fast-launch enabled Windows AMI.

        • timeoutMinutesrequired — (Integer)

          The maximum duration in minutes for this distribution configuration.

        • dateCreated — (String)

          The date on which this distribution configuration was created.

        • dateUpdated — (String)

          The date on which this distribution configuration was last updated.

        • tags — (map<String>)

          The tags of the distribution configuration.

Returns:

  • (AWS.Request)

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

getImage(params = {}, callback) ⇒ AWS.Request

Gets an image.

Service Reference:

Examples:

Calling the getImage operation

var params = {
  imageBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.getImage(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: {})
    • imageBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the image that you want to get.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • image — (map)

        The image object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • type — (String)

          Specifies whether this image produces an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • name — (String)

          The name of the image.

        • version — (String)

          The semantic version of the image.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • platform — (String)

          The image operating system platform, such as Linux or Windows.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

        • osVersion — (String)

          The operating system version for instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
            • "DISABLED"
          • reason — (String)

            The reason for the status of the image.

        • imageRecipe — (map)

          For images that distribute an AMI, this is the image recipe that Image Builder used to create the image. For container images, this is empty.

          • arn — (String)

            The Amazon Resource Name (ARN) of the image recipe.

          • type — (String)

            Specifies which type of image is created by the recipe - an AMI or a container image.

            Possible values include:
            • "AMI"
            • "DOCKER"
          • name — (String)

            The name of the image recipe.

          • description — (String)

            The description of the image recipe.

          • platform — (String)

            The platform of the image recipe.

            Possible values include:
            • "Windows"
            • "Linux"
          • owner — (String)

            The owner of the image recipe.

          • version — (String)

            The version of the image recipe.

          • components — (Array<map>)

            The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

            • componentArnrequired — (String)

              The Amazon Resource Name (ARN) of the component.

            • parameters — (Array<map>)

              A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

              • namerequired — (String)

                The name of the component parameter to set.

              • valuerequired — (Array<String>)

                Sets the value for the named component parameter.

          • parentImage — (String)

            The base image of the image recipe.

          • blockDeviceMappings — (Array<map>)

            The block device mappings to apply when creating images from this recipe.

            • deviceName — (String)

              The device to which these mappings apply.

            • ebs — (map)

              Use to manage Amazon EBS-specific configuration for this mapping.

              • encrypted — (Boolean)

                Use to configure device encryption.

              • deleteOnTermination — (Boolean)

                Use to configure delete on termination of the associated device.

              • iops — (Integer)

                Use to configure device IOPS.

              • kmsKeyId — (String)

                Use to configure the KMS key to use when encrypting the device.

              • snapshotId — (String)

                The snapshot that defines the device contents.

              • volumeSize — (Integer)

                Use to override the device's volume size.

              • volumeType — (String)

                Use to override the device's volume type.

                Possible values include:
                • "standard"
                • "io1"
                • "io2"
                • "gp2"
                • "gp3"
                • "sc1"
                • "st1"
              • throughput — (Integer)

                For GP3 volumes only – The throughput in MiB/s that the volume supports.

            • virtualName — (String)

              Use to manage instance ephemeral devices.

            • noDevice — (String)

              Use to remove a mapping from the base image.

          • dateCreated — (String)

            The date on which this image recipe was created.

          • tags — (map<String>)

            The tags of the image recipe.

          • workingDirectory — (String)

            The working directory to be used during build and test workflows.

          • additionalInstanceConfiguration — (map)

            Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

            • systemsManagerAgent — (map)

              Contains settings for the Systems Manager agent on your build instance.

              • uninstallAfterBuild — (Boolean)

                Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

            • userDataOverride — (String)

              Use this property to provide commands or a command script to run when you launch your build instance.

              The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

              Note: The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$: #!/bin/bash mkdir -p /var/bb/ touch /var
        • containerRecipe — (map)

          For container images, this is the container recipe that Image Builder used to create the image. For images that distribute an AMI, this is empty.

          • arn — (String)

            The Amazon Resource Name (ARN) of the container recipe.

            Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
            1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
            2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
            3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
          • containerType — (String)

            Specifies the type of container, such as Docker.

            Possible values include:
            • "DOCKER"
          • name — (String)

            The name of the container recipe.

          • description — (String)

            The description of the container recipe.

          • platform — (String)

            The system platform for the container, such as Windows or Linux.

            Possible values include:
            • "Windows"
            • "Linux"
          • owner — (String)

            The owner of the container recipe.

          • version — (String)

            The semantic version of the container recipe.

            Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
          • components — (Array<map>)

            Build and test components that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

            • componentArnrequired — (String)

              The Amazon Resource Name (ARN) of the component.

            • parameters — (Array<map>)

              A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

              • namerequired — (String)

                The name of the component parameter to set.

              • valuerequired — (Array<String>)

                Sets the value for the named component parameter.

          • instanceConfiguration — (map)

            A group of options that can be used to configure an instance for building and testing container images.

            • image — (String)

              The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image.

            • blockDeviceMappings — (Array<map>)

              Defines the block devices to attach for building an instance from this Image Builder AMI.

              • deviceName — (String)

                The device to which these mappings apply.

              • ebs — (map)

                Use to manage Amazon EBS-specific configuration for this mapping.

                • encrypted — (Boolean)

                  Use to configure device encryption.

                • deleteOnTermination — (Boolean)

                  Use to configure delete on termination of the associated device.

                • iops — (Integer)

                  Use to configure device IOPS.

                • kmsKeyId — (String)

                  Use to configure the KMS key to use when encrypting the device.

                • snapshotId — (String)

                  The snapshot that defines the device contents.

                • volumeSize — (Integer)

                  Use to override the device's volume size.

                • volumeType — (String)

                  Use to override the device's volume type.

                  Possible values include:
                  • "standard"
                  • "io1"
                  • "io2"
                  • "gp2"
                  • "gp3"
                  • "sc1"
                  • "st1"
                • throughput — (Integer)

                  For GP3 volumes only – The throughput in MiB/s that the volume supports.

              • virtualName — (String)

                Use to manage instance ephemeral devices.

              • noDevice — (String)

                Use to remove a mapping from the base image.

          • dockerfileTemplateData — (String)

            Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

          • kmsKeyId — (String)

            Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

          • encrypted — (Boolean)

            A flag that indicates if the target container is encrypted.

          • parentImage — (String)

            The base image for the container recipe.

          • dateCreated — (String)

            The date when this container recipe was created.

          • tags — (map<String>)

            Tags that are attached to the container recipe.

          • workingDirectory — (String)

            The working directory for use during build and test workflows.

          • targetRepository — (map)

            The destination repository for the container image.

            • servicerequired — (String)

              Specifies the service in which this image was registered.

              Possible values include:
              • "ECR"
            • repositoryNamerequired — (String)

              The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

        • sourcePipelineName — (String)

          The name of the image pipeline that created this image.

        • sourcePipelineArn — (String)

          The Amazon Resource Name (ARN) of the image pipeline that created this image.

        • infrastructureConfiguration — (map)

          The infrastructure that Image Builder used to create this image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the infrastructure configuration.

          • name — (String)

            The name of the infrastructure configuration.

          • description — (String)

            The description of the infrastructure configuration.

          • instanceTypes — (Array<String>)

            The instance types of the infrastructure configuration.

          • instanceProfileName — (String)

            The instance profile of the infrastructure configuration.

          • securityGroupIds — (Array<String>)

            The security group IDs of the infrastructure configuration.

          • subnetId — (String)

            The subnet ID of the infrastructure configuration.

          • logging — (map)

            The logging configuration of the infrastructure configuration.

            • s3Logs — (map)

              The Amazon S3 logging configuration.

              • s3BucketName — (String)

                The S3 bucket in which to store the logs.

              • s3KeyPrefix — (String)

                The Amazon S3 path to the bucket where the logs are stored.

          • keyPair — (String)

            The Amazon EC2 key pair of the infrastructure configuration.

          • terminateInstanceOnFailure — (Boolean)

            The terminate instance on failure configuration of the infrastructure configuration.

          • snsTopicArn — (String)

            The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

            Note: EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
          • dateCreated — (String)

            The date on which the infrastructure configuration was created.

          • dateUpdated — (String)

            The date on which the infrastructure configuration was last updated.

          • resourceTags — (map<String>)

            The tags attached to the resource created by Image Builder.

          • instanceMetadataOptions — (map)

            The instance metadata option settings for the infrastructure configuration.

            • httpTokens — (String)

              Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

              • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

              • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

              The default setting is optional.

            • httpPutResponseHopLimit — (Integer)

              Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

          • tags — (map<String>)

            The tags of the infrastructure configuration.

        • distributionConfiguration — (map)

          The distribution configuration that Image Builder used to create this image.

          • arn — (String)

            The Amazon Resource Name (ARN) of the distribution configuration.

          • name — (String)

            The name of the distribution configuration.

          • description — (String)

            The description of the distribution configuration.

          • distributions — (Array<map>)

            The distribution objects that apply Region-specific settings for the deployment of the image to targeted Regions.

            • regionrequired — (String)

              The target Region.

            • amiDistributionConfiguration — (map)

              The specific AMI settings; for example, launch permissions or AMI tags.

              • name — (String)

                The name of the output AMI.

              • description — (String)

                The description of the AMI distribution configuration. Minimum and maximum length are in characters.

              • targetAccountIds — (Array<String>)

                The ID of an account to which you want to distribute an image.

              • amiTags — (map<String>)

                The tags to apply to AMIs distributed to this Region.

              • kmsKeyId — (String)

                The KMS key identifier used to encrypt the distributed image.

              • launchPermission — (map)

                Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

                • userIds — (Array<String>)

                  The Amazon Web Services account ID.

                • userGroups — (Array<String>)

                  The name of the group.

                • organizationArns — (Array<String>)

                  The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

                • organizationalUnitArns — (Array<String>)

                  The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

            • containerDistributionConfiguration — (map)

              Container distribution settings for encryption, licensing, and sharing in a specific Region.

              • description — (String)

                The description of the container distribution configuration.

              • containerTags — (Array<String>)

                Tags that are attached to the container distribution configuration.

              • targetRepositoryrequired — (map)

                The destination repository for the container distribution configuration.

                • servicerequired — (String)

                  Specifies the service in which this image was registered.

                  Possible values include:
                  • "ECR"
                • repositoryNamerequired — (String)

                  The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

            • licenseConfigurationArns — (Array<String>)

              The License Manager Configuration to associate with the AMI in the specified Region.

            • launchTemplateConfigurations — (Array<map>)

              A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

              • launchTemplateIdrequired — (String)

                Identifies the Amazon EC2 launch template to use.

              • accountId — (String)

                The account ID that this configuration applies to.

              • setDefaultVersion — (Boolean)

                Set the specified Amazon EC2 launch template as the default launch template for the specified account.

            • s3ExportConfiguration — (map)

              Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

              • roleNamerequired — (String)

                The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

              • diskImageFormatrequired — (String)

                Export the updated image to one of the following supported disk image formats:

                • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

                • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

                • Raw – Raw format.

                Possible values include:
                • "VMDK"
                • "RAW"
                • "VHD"
              • s3Bucketrequired — (String)

                The S3 bucket in which to store the output disk images for your VM.

              • s3Prefix — (String)

                The Amazon S3 path for the bucket where the output disk images for your VM are stored.

            • fastLaunchConfigurations — (Array<map>)

              The Windows faster-launching configurations to use for AMI distribution.

              • enabledrequired — (Boolean)

                A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

              • snapshotConfiguration — (map)

                Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

                • targetResourceCount — (Integer)

                  The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

              • maxParallelLaunches — (Integer)

                The maximum number of parallel instances that are launched for creating resources.

              • launchTemplate — (map)

                The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

                • launchTemplateId — (String)

                  The ID of the launch template to use for faster launching for a Windows AMI.

                • launchTemplateName — (String)

                  The name of the launch template to use for faster launching for a Windows AMI.

                • launchTemplateVersion — (String)

                  The version of the launch template to use for faster launching for a Windows AMI.

              • accountId — (String)

                The owner account ID for the fast-launch enabled Windows AMI.

          • timeoutMinutesrequired — (Integer)

            The maximum duration in minutes for this distribution configuration.

          • dateCreated — (String)

            The date on which this distribution configuration was created.

          • dateUpdated — (String)

            The date on which this distribution configuration was last updated.

          • tags — (map<String>)

            The tags of the distribution configuration.

        • imageTestsConfiguration — (map)

          The image tests that ran when that Image Builder created this image.

          • imageTestsEnabled — (Boolean)

            Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

            Note: The timeoutMinutes attribute is not currently active. This value is ignored.
        • dateCreated — (String)

          The date on which Image Builder created this image.

        • outputResources — (map)

          The output resources that Image Builder produces for this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
                • "DISABLED"
              • reason — (String)

                The reason for the status of the image.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags that apply to this image.

        • buildType — (String)

          Indicates the type of build that created this image. The build can be initiated in the following ways:

          • USER_INITIATED – A manual pipeline build request.

          • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

          • IMPORT – A VM import created the image to use as the base image for the recipe.

          Possible values include:
          • "USER_INITIATED"
          • "SCHEDULED"
          • "IMPORT"
        • imageSource — (String)

          The origin of the base image that Image Builder used to build this image.

          Possible values include:
          • "AMAZON_MANAGED"
          • "AWS_MARKETPLACE"
          • "IMPORTED"
          • "CUSTOM"
        • scanState — (map)

          Contains information about the current state of scans for this image.

          • status — (String)

            The current state of vulnerability scans for the image.

            Possible values include:
            • "PENDING"
            • "SCANNING"
            • "COLLECTING"
            • "COMPLETED"
            • "ABANDONED"
            • "FAILED"
            • "TIMED_OUT"
          • reason — (String)

            The reason for the scan status for the image.

        • imageScanningConfiguration — (map)

          Contains settings for vulnerability scans.

          • imageScanningEnabled — (Boolean)

            A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

          • ecrConfiguration — (map)

            Contains Amazon ECR settings for vulnerability scans.

            • repositoryName — (String)

              The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

            • containerTags — (Array<String>)

              Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

        • deprecationTime — (Date)

          The time when deprecation occurs for an image resource. This can be a past or future date.

        • lifecycleExecutionId — (String)

          Identifies the last runtime instance of the lifecycle policy to take action on the image.

        • executionRole — (String)

          The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

        • workflows — (Array<map>)

          Contains the build and test workflows that are associated with the image.

          • workflowArnrequired — (String)

            The Amazon Resource Name (ARN) of the workflow resource.

          • parameters — (Array<map>)

            Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

            • namerequired — (String)

              The name of the workflow parameter to set.

            • valuerequired — (Array<String>)

              Sets the value for the named workflow parameter.

          • parallelGroup — (String)

            Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

          • onFailure — (String)

            The action to take if the workflow fails.

            Possible values include:
            • "CONTINUE"
            • "ABORT"

Returns:

  • (AWS.Request)

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

getImagePipeline(params = {}, callback) ⇒ AWS.Request

Gets an image pipeline.

Service Reference:

Examples:

Calling the getImagePipeline operation

var params = {
  imagePipelineArn: 'STRING_VALUE' /* required */
};
imagebuilder.getImagePipeline(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: {})
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline that you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipeline — (map)

        The image pipeline object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image pipeline.

        • name — (String)

          The name of the image pipeline.

        • description — (String)

          The description of the image pipeline.

        • platform — (String)

          The platform of the image pipeline.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

        • imageRecipeArn — (String)

          The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

        • containerRecipeArn — (String)

          The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

        • infrastructureConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

        • distributionConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

        • imageTestsConfiguration — (map)

          The image tests configuration of the image pipeline.

          • imageTestsEnabled — (Boolean)

            Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

            Note: The timeoutMinutes attribute is not currently active. This value is ignored.
        • schedule — (map)

          The schedule of the image pipeline.

          • scheduleExpression — (String)

            The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

            For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

          • timezone — (String)

            The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

          • pipelineExecutionStartCondition — (String)

            The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

            Possible values include:
            • "EXPRESSION_MATCH_ONLY"
            • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        • status — (String)

          The status of the image pipeline.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • dateCreated — (String)

          The date on which this image pipeline was created.

        • dateUpdated — (String)

          The date on which this image pipeline was last updated.

        • dateLastRun — (String)

          This is no longer supported, and does not return a value.

        • dateNextRun — (String)

          The next date when the pipeline is scheduled to run.

        • tags — (map<String>)

          The tags of this image pipeline.

        • imageScanningConfiguration — (map)

          Contains settings for vulnerability scans.

          • imageScanningEnabled — (Boolean)

            A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

          • ecrConfiguration — (map)

            Contains Amazon ECR settings for vulnerability scans.

            • repositoryName — (String)

              The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

            • containerTags — (Array<String>)

              Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

        • executionRole — (String)

          The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

        • workflows — (Array<map>)

          Contains the workflows that run for the image pipeline.

          • workflowArnrequired — (String)

            The Amazon Resource Name (ARN) of the workflow resource.

          • parameters — (Array<map>)

            Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

            • namerequired — (String)

              The name of the workflow parameter to set.

            • valuerequired — (Array<String>)

              Sets the value for the named workflow parameter.

          • parallelGroup — (String)

            Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

          • onFailure — (String)

            The action to take if the workflow fails.

            Possible values include:
            • "CONTINUE"
            • "ABORT"

Returns:

  • (AWS.Request)

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

getImagePolicy(params = {}, callback) ⇒ AWS.Request

Gets an image policy.

Service Reference:

Examples:

Calling the getImagePolicy operation

var params = {
  imageArn: 'STRING_VALUE' /* required */
};
imagebuilder.getImagePolicy(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: {})
    • imageArn — (String)

      The Amazon Resource Name (ARN) of the image whose policy you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The image policy object.

Returns:

  • (AWS.Request)

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

getImageRecipe(params = {}, callback) ⇒ AWS.Request

Gets an image recipe.

Service Reference:

Examples:

Calling the getImageRecipe operation

var params = {
  imageRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.getImageRecipe(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: {})
    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipe — (map)

        The image recipe object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image recipe.

        • type — (String)

          Specifies which type of image is created by the recipe - an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • name — (String)

          The name of the image recipe.

        • description — (String)

          The description of the image recipe.

        • platform — (String)

          The platform of the image recipe.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the image recipe.

        • version — (String)

          The version of the image recipe.

        • components — (Array<map>)

          The components that are included in the image recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

          • componentArnrequired — (String)

            The Amazon Resource Name (ARN) of the component.

          • parameters — (Array<map>)

            A group of parameter settings that Image Builder uses to configure the component for a specific recipe.

            • namerequired — (String)

              The name of the component parameter to set.

            • valuerequired — (Array<String>)

              Sets the value for the named component parameter.

        • parentImage — (String)

          The base image of the image recipe.

        • blockDeviceMappings — (Array<map>)

          The block device mappings to apply when creating images from this recipe.

          • deviceName — (String)

            The device to which these mappings apply.

          • ebs — (map)

            Use to manage Amazon EBS-specific configuration for this mapping.

            • encrypted — (Boolean)

              Use to configure device encryption.

            • deleteOnTermination — (Boolean)

              Use to configure delete on termination of the associated device.

            • iops — (Integer)

              Use to configure device IOPS.

            • kmsKeyId — (String)

              Use to configure the KMS key to use when encrypting the device.

            • snapshotId — (String)

              The snapshot that defines the device contents.

            • volumeSize — (Integer)

              Use to override the device's volume size.

            • volumeType — (String)

              Use to override the device's volume type.

              Possible values include:
              • "standard"
              • "io1"
              • "io2"
              • "gp2"
              • "gp3"
              • "sc1"
              • "st1"
            • throughput — (Integer)

              For GP3 volumes only – The throughput in MiB/s that the volume supports.

          • virtualName — (String)

            Use to manage instance ephemeral devices.

          • noDevice — (String)

            Use to remove a mapping from the base image.

        • dateCreated — (String)

          The date on which this image recipe was created.

        • tags — (map<String>)

          The tags of the image recipe.

        • workingDirectory — (String)

          The working directory to be used during build and test workflows.

        • additionalInstanceConfiguration — (map)

          Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

          • systemsManagerAgent — (map)

            Contains settings for the Systems Manager agent on your build instance.

            • uninstallAfterBuild — (Boolean)

              Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.

          • userDataOverride — (String)

            Use this property to provide commands or a command script to run when you launch your build instance.

            The userDataOverride property replaces any commands that Image Builder might have added to ensure that Systems Manager is installed on your Linux build instance. If you override the user data, make sure that you add commands to install Systems Manager, if it is not pre-installed on your base image.

            Note: The user data is always base 64 encoded. For example, the following commands are encoded as IyEvYmluL2Jhc2gKbWtkaXIgLXAgL3Zhci9iYi8KdG91Y2ggL3Zhci$: #!/bin/bash mkdir -p /var/bb/ touch /var

Returns:

  • (AWS.Request)

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

getImageRecipePolicy(params = {}, callback) ⇒ AWS.Request

Gets an image recipe policy.

Service Reference:

Examples:

Calling the getImageRecipePolicy operation

var params = {
  imageRecipeArn: 'STRING_VALUE' /* required */
};
imagebuilder.getImageRecipePolicy(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: {})
    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe whose policy you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • policy — (String)

        The image recipe policy object.

Returns:

  • (AWS.Request)

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

getInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Gets an infrastructure configuration.

Service Reference:

Examples:

Calling the getInfrastructureConfiguration operation

var params = {
  infrastructureConfigurationArn: 'STRING_VALUE' /* required */
};
imagebuilder.getInfrastructureConfiguration(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: {})
    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that you want 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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfiguration — (map)

        The infrastructure configuration object.

        • arn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration.

        • name — (String)

          The name of the infrastructure configuration.

        • description — (String)

          The description of the infrastructure configuration.

        • instanceTypes — (Array<String>)

          The instance types of the infrastructure configuration.

        • instanceProfileName — (String)

          The instance profile of the infrastructure configuration.

        • securityGroupIds — (Array<String>)

          The security group IDs of the infrastructure configuration.

        • subnetId — (String)

          The subnet ID of the infrastructure configuration.

        • logging — (map)

          The logging configuration of the infrastructure configuration.

          • s3Logs — (map)

            The Amazon S3 logging configuration.

            • s3BucketName — (String)

              The S3 bucket in which to store the logs.

            • s3KeyPrefix — (String)

              The Amazon S3 path to the bucket where the logs are stored.

        • keyPair — (String)

          The Amazon EC2 key pair of the infrastructure configuration.

        • terminateInstanceOnFailure — (Boolean)

          The terminate instance on failure configuration of the infrastructure configuration.

        • snsTopicArn — (String)

          The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

          Note: EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
        • dateCreated — (String)

          The date on which the infrastructure configuration was created.

        • dateUpdated — (String)

          The date on which the infrastructure configuration was last updated.

        • resourceTags — (map<String>)

          The tags attached to the resource created by Image Builder.

        • instanceMetadataOptions — (map)

          The instance metadata option settings for the infrastructure configuration.

          • httpTokens — (String)

            Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

            • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

            • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

            The default setting is optional.

          • httpPutResponseHopLimit — (Integer)

            Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

        • tags — (map<String>)

          The tags of the infrastructure configuration.

Returns:

  • (AWS.Request)

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

getLifecycleExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the lifecycle policy.

Service Reference:

Examples:

Calling the getLifecycleExecution operation

var params = {
  lifecycleExecutionId: 'STRING_VALUE' /* required */
};
imagebuilder.getLifecycleExecution(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: {})
    • lifecycleExecutionId — (String)

      Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

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:

      • lifecycleExecution — (map)

        Runtime details for the specified runtime instance of the lifecycle policy.

        • lifecycleExecutionId — (String)

          Identifies the lifecycle policy runtime instance.

        • lifecyclePolicyArn — (String)

          The Amazon Resource Name (ARN) of the lifecycle policy that ran.

        • resourcesImpactedSummary — (map)

          Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy.

          • hasImpactedResources — (Boolean)

            Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.

        • state — (map)

          Runtime state that reports if the policy action ran successfully, failed, or was skipped.

          • status — (String)

            The runtime status of the lifecycle execution.

            Possible values include:
            • "IN_PROGRESS"
            • "CANCELLED"
            • "CANCELLING"
            • "FAILED"
            • "SUCCESS"
            • "PENDING"
          • reason — (String)

            The reason for the current status.

        • startTime — (Date)

          The timestamp when the lifecycle runtime instance started.

        • endTime — (Date)

          The timestamp when the lifecycle runtime instance completed.

Returns:

  • (AWS.Request)

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

getLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Get details for the specified image lifecycle policy.

Service Reference:

Examples:

Calling the getLifecyclePolicy operation

var params = {
  lifecyclePolicyArn: 'STRING_VALUE' /* required */
};
imagebuilder.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: {})
    • lifecyclePolicyArn — (String)

      Specifies the Amazon Resource Name (ARN) of the image lifecycle policy resource to get.

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:

      • lifecyclePolicy — (map)

        The ARN of the image lifecycle policy resource that was returned.

        • arn — (String)

          The Amazon Resource Name (ARN) of the lifecycle policy resource.

        • name — (String)

          The name of the lifecycle policy.

        • description — (String)

          Optional description for the lifecycle policy.

        • status — (String)

          Indicates whether the lifecycle policy resource is enabled.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • executionRole — (String)

          The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy. This is a custom role that you create.

        • resourceType — (String)

          The type of resources the lifecycle policy targets.

          Possible values include:
          • "AMI_IMAGE"
          • "CONTAINER_IMAGE"
        • policyDetails — (Array<map>)

          The configuration details for a lifecycle policy resource.

          • actionrequired — (map)

            Configuration details for the policy action.

            • typerequired — (String)

              Specifies the lifecycle action to take.

              Possible values include:
              • "DELETE"
              • "DEPRECATE"
              • "DISABLE"
            • includeResources — (map)

              Specifies the resources that the lifecycle policy applies to.

              • amis — (Boolean)

                Specifies whether the lifecycle action should apply to distributed AMIs.

              • snapshots — (Boolean)

                Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

              • containers — (Boolean)

                Specifies whether the lifecycle action should apply to distributed containers.

          • filterrequired — (map)

            Specifies the resources that the lifecycle policy applies to.

            • typerequired — (String)

              Filter resources based on either age or count.

              Possible values include:
              • "AGE"
              • "COUNT"
            • valuerequired — (Integer)

              The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.

              Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
            • unit — (String)

              Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.

              Possible values include:
              • "DAYS"
              • "WEEKS"
              • "MONTHS"
              • "YEARS"
            • retainAtLeast — (Integer)

              For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

          • exclusionRules — (map)

            Additional rules to specify resources that should be exempt from policy actions.

            • tagMap — (map<String>)

              Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

            • amis — (map)

              Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

              • isPublic — (Boolean)

                Configures whether public AMIs are excluded from the lifecycle action.

              • regions — (Array<String>)

                Configures Amazon Web Services Regions that are excluded from the lifecycle action.

              • sharedAccounts — (Array<String>)

                Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.

              • lastLaunched — (map)

                Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

                • valuerequired — (Integer)

                  The integer number of units for the time period. For example 6 (months).

                • unitrequired — (String)

                  Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.

                  Possible values include:
                  • "DAYS"
                  • "WEEKS"
                  • "MONTHS"
                  • "YEARS"
              • tagMap — (map<String>)

                Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

        • resourceSelection — (map)

          Resource selection criteria used to run the lifecycle policy.

          • recipes — (Array<map>)

            A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

            • namerequired — (String)

              The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

            • semanticVersionrequired — (String)

              The version of the Image Builder recipe specified by the name field.

          • tagMap — (map<String>)

            A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

        • dateCreated — (Date)

          The timestamp when Image Builder created the lifecycle policy resource.

        • dateUpdated — (Date)

          The timestamp when Image Builder updated the lifecycle policy resource.

        • dateLastRun — (Date)

          The timestamp for the last time Image Builder ran the lifecycle policy.

        • tags — (map<String>)

          To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.

Returns:

  • (AWS.Request)

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

getWorkflow(params = {}, callback) ⇒ AWS.Request

Get a workflow resource object.

Service Reference:

Examples:

Calling the getWorkflow operation

var params = {
  workflowBuildVersionArn: 'STRING_VALUE' /* required */
};
imagebuilder.getWorkflow(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: {})
    • workflowBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the workflow resource that you want to get.

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:

      • workflow — (map)

        The workflow resource specified in the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the workflow resource.

        • name — (String)

          The name of the workflow resource.

        • version — (String)

          The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.

        • description — (String)

          The description of the workflow.

        • changeDescription — (String)

          Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

        • type — (String)

          Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.

          Possible values include:
          • "BUILD"
          • "TEST"
          • "DISTRIBUTION"
        • state — (map)

          Describes the current status of the workflow and the reason for that status.

          • status — (String)

            The current state of the workflow.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the workflow changed state.

        • owner — (String)

          The owner of the workflow resource.

        • data — (String)

          Contains the YAML document content for the workflow.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the workflow resource.

        • dateCreated — (String)

          The timestamp when Image Builder created the workflow resource.

        • tags — (map<String>)

          The tags that apply to the workflow resource

        • parameters — (Array<map>)

          An array of input parameters that that the image workflow uses to control actions or configure settings.

          • namerequired — (String)

            The name of this input parameter.

          • typerequired — (String)

            The type of input this parameter provides. The currently supported value is "string".

          • defaultValue — (Array<String>)

            The default value of this parameter if no input is provided.

          • description — (String)

            Describes this parameter.

Returns:

  • (AWS.Request)

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

getWorkflowExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the workflow.

Service Reference:

Examples:

Calling the getWorkflowExecution operation

var params = {
  workflowExecutionId: 'STRING_VALUE' /* required */
};
imagebuilder.getWorkflowExecution(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: {})
    • workflowExecutionId — (String)

      Use the unique identifier for a runtime instance of the workflow to get runtime details.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • workflowBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

      • workflowExecutionId — (String)

        The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow created.

      • type — (String)

        The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

        Possible values include:
        • "BUILD"
        • "TEST"
        • "DISTRIBUTION"
      • status — (String)

        The current runtime status for the specified runtime instance of the workflow.

        Possible values include:
        • "PENDING"
        • "SKIPPED"
        • "RUNNING"
        • "COMPLETED"
        • "FAILED"
        • "ROLLBACK_IN_PROGRESS"
        • "ROLLBACK_COMPLETED"
        • "CANCELLED"
      • message — (String)

        The output message from the specified runtime instance of the workflow, if applicable.

      • totalStepCount — (Integer)

        The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

      • totalStepsSucceeded — (Integer)

        A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.

      • totalStepsFailed — (Integer)

        A runtime count for the number of steps that failed in the specified runtime instance of the workflow.

      • totalStepsSkipped — (Integer)

        A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.

      • startTime — (String)

        The timestamp when the specified runtime instance of the workflow started.

      • endTime — (String)

        The timestamp when the specified runtime instance of the workflow finished.

      • parallelGroup — (String)

        Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows.

Returns:

  • (AWS.Request)

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

getWorkflowStepExecution(params = {}, callback) ⇒ AWS.Request

Get the runtime information that was logged for a specific runtime instance of the workflow step.

Service Reference:

Examples:

Calling the getWorkflowStepExecution operation

var params = {
  stepExecutionId: 'STRING_VALUE' /* required */
};
imagebuilder.getWorkflowStepExecution(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: {})
    • stepExecutionId — (String)

      Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • stepExecutionId — (String)

        The unique identifier for the runtime version of the workflow step that you specified in the request.

      • workflowBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.

      • workflowExecutionId — (String)

        The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.

      • name — (String)

        The name of the specified runtime instance of the workflow step.

      • description — (String)

        Describes the specified workflow step.

      • action — (String)

        The name of the action that the specified step performs.

      • status — (String)

        The current status for the specified runtime version of the workflow step.

        Possible values include:
        • "PENDING"
        • "SKIPPED"
        • "RUNNING"
        • "COMPLETED"
        • "FAILED"
        • "CANCELLED"
      • rollbackStatus — (String)

        Reports on the rollback status of the specified runtime version of the workflow step, if applicable.

        Possible values include:
        • "RUNNING"
        • "COMPLETED"
        • "SKIPPED"
        • "FAILED"
      • message — (String)

        The output message from the specified runtime instance of the workflow step, if applicable.

      • inputs — (String)

        Input parameters that Image Builder provided for the specified runtime instance of the workflow step.

      • outputs — (String)

        The file names that the specified runtime version of the workflow step created as output.

      • startTime — (String)

        The timestamp when the specified runtime version of the workflow step started.

      • endTime — (String)

        The timestamp when the specified runtime instance of the workflow step finished.

      • onFailure — (String)

        The action to perform if the workflow step fails.

      • timeoutSeconds — (Integer)

        The maximum duration in seconds for this step to complete its action.

Returns:

  • (AWS.Request)

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

importComponent(params = {}, callback) ⇒ AWS.Request

Imports a component and transforms its data into a component document.

Service Reference:

Examples:

Calling the importComponent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  format: SHELL, /* required */
  name: 'STRING_VALUE', /* required */
  platform: Windows | Linux, /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  type: BUILD | TEST, /* required */
  changeDescription: 'STRING_VALUE',
  data: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyId: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  uri: 'STRING_VALUE'
};
imagebuilder.importComponent(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)

      The name of the component.

    • semanticVersion — (String)

      The semantic version of the component. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    • description — (String)

      The description of the component. Describes the contents of the component.

    • changeDescription — (String)

      The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.

    • type — (String)

      The type of the component denotes whether the component is used to build the image, or only to test it.

      Possible values include:
      • "BUILD"
      • "TEST"
    • format — (String)

      The format of the resource that you want to import as a component.

      Possible values include:
      • "SHELL"
    • platform — (String)

      The platform of the component.

      Possible values include:
      • "Windows"
      • "Linux"
    • data — (String)

      The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

    • uri — (String)

      The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

    • kmsKeyId — (String)

      The ID of the KMS key that should be used to encrypt this component.

    • tags — (map<String>)

      The tags of the component.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • componentBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the imported component.

Returns:

  • (AWS.Request)

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

importVmImage(params = {}, callback) ⇒ AWS.Request

When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API ImportImage action uses those files to import your VM and create an AMI. To import using the CLI command, see import-image

You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.

Service Reference:

Examples:

Calling the importVmImage operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  platform: Windows | Linux, /* required */
  semanticVersion: 'STRING_VALUE', /* required */
  vmImportTaskId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  osVersion: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.importVmImage(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)

      The name of the base image that is created by the import process.

    • semanticVersion — (String)

      The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

      Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    • description — (String)

      The description for the base image that is created by the import process.

    • platform — (String)

      The operating system platform for the imported VM.

      Possible values include:
      • "Windows"
      • "Linux"
    • osVersion — (String)

      The operating system version for the imported VM.

    • vmImportTaskId — (String)

      The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

    • tags — (map<String>)

      Tags that are attached to the import resources.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageArn — (String)

        The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.

      • clientToken — (String)

        The client token that uniquely identifies the request.

Returns:

  • (AWS.Request)

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

listComponentBuildVersions(params = {}, callback) ⇒ AWS.Request

Returns the list of component build versions for the specified semantic version.

Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Service Reference:

Examples:

Calling the listComponentBuildVersions operation

var params = {
  componentVersionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listComponentBuildVersions(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: {})
    • componentVersionArn — (String)

      The component version Amazon Resource Name (ARN) whose versions you want to list.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentSummaryList — (Array<map>)

        The list of component summaries for the specified semantic version.

        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

        • name — (String)

          The name of the component.

        • version — (String)

          The version of the component.

        • platform — (String)

          The operating system platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

        • state — (map)

          Describes the current status of the component.

          • status — (String)

            The current state of the component.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the component changed state.

        • type — (String)

          The component type specifies whether Image Builder uses the component to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • owner — (String)

          The owner of the component.

        • description — (String)

          The description of the component.

        • changeDescription — (String)

          The change description for the current version of the component.

        • dateCreated — (String)

          The original creation date of the component.

        • tags — (map<String>)

          The tags that apply to the component.

        • publisher — (String)

          Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

        • obfuscate — (Boolean)

          Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listComponents(params = {}, callback) ⇒ AWS.Request

Returns the list of components that can be filtered by name, or by using the listed filters to streamline results. Newly created components can take up to two minutes to appear in the ListComponents API Results.

Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  byName: true || false,
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon | ThirdParty
};
imagebuilder.listComponents(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: {})
    • owner — (String)

      Filters results based on the type of owner for the component. By default, this request returns a list of components that your account owns. To see results for other types of owners, you can specify components that Amazon manages, third party components, or components that other accounts have shared with you.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
      • "ThirdParty"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • description

      • name

      • platform

      • supportedOsVersion

      • type

      • version

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • byName — (Boolean)

      Returns the list of components for the specified name.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentVersionList — (Array<map>)

        The list of component semantic versions.

        Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
        • arn — (String)

          The Amazon Resource Name (ARN) of the component.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • name — (String)

          The name of the component.

        • version — (String)

          The semantic version of the component.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • description — (String)

          The description of the component.

        • platform — (String)

          The platform of the component.

          Possible values include:
          • "Windows"
          • "Linux"
        • supportedOsVersions — (Array<String>)

          he operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        • type — (String)

          The type of the component denotes whether the component is used to build the image or only to test it.

          Possible values include:
          • "BUILD"
          • "TEST"
        • owner — (String)

          The owner of the component.

        • dateCreated — (String)

          The date that the component was created.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listContainerRecipes(params = {}, callback) ⇒ AWS.Request

Returns a list of container recipes.

Service Reference:

Examples:

Calling the listContainerRecipes operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon | ThirdParty
};
imagebuilder.listContainerRecipes(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: {})
    • owner — (String)

      Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
      • "ThirdParty"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • containerType

      • name

      • parentImage

      • platform

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeSummaryList — (Array<map>)

        The list of container recipes returned for the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the container recipe.

        • containerType — (String)

          Specifies the type of container, such as "Docker".

          Possible values include:
          • "DOCKER"
        • name — (String)

          The name of the container recipe.

        • platform — (String)

          The system platform for the container, such as Windows or Linux.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the container recipe.

        • parentImage — (String)

          The base image for the container recipe.

        • dateCreated — (String)

          The date when this container recipe was created.

        • tags — (map<String>)

          Tags that are attached to the container recipe.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listDistributionConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of distribution configurations.

Service Reference:

Examples:

Calling the listDistributionConfigurations operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listDistributionConfigurations(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: {})
    • filters — (Array<map>)

      You can filter on name to streamline results.

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • distributionConfigurationSummaryList — (Array<map>)

        The list of distributions.

        • arn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration.

        • name — (String)

          The name of the distribution configuration.

        • description — (String)

          The description of the distribution configuration.

        • dateCreated — (String)

          The date on which the distribution configuration was created.

        • dateUpdated — (String)

          The date on which the distribution configuration was updated.

        • tags — (map<String>)

          The tags associated with the distribution configuration.

        • regions — (Array<String>)

          A list of Regions where the container image is distributed to.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImageBuildVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of image build versions.

Service Reference:

Examples:

Calling the listImageBuildVersions operation

var params = {
  imageVersionArn: 'STRING_VALUE', /* required */
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImageBuildVersions(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: {})
    • imageVersionArn — (String)

      The Amazon Resource Name (ARN) of the image whose build versions you want to retrieve.

    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageSummaryList — (Array<map>)

        The list of image build versions.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

        • name — (String)

          The name of the image.

        • type — (String)

          Specifies whether this image produces an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          The version of the image.

        • platform — (String)

          The image operating system platform, such as Linux or Windows.

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
            • "DISABLED"
          • reason — (String)

            The reason for the status of the image.

        • owner — (String)

          The owner of the image.

        • dateCreated — (String)

          The date on which Image Builder created this image.

        • outputResources — (map)

          The output resources that Image Builder produced when it created this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
                • "DISABLED"
              • reason — (String)

                The reason for the status of the image.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags that apply to this image.

        • buildType — (String)

          Indicates the type of build that created this image. The build can be initiated in the following ways:

          • USER_INITIATED – A manual pipeline build request.

          • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

          • IMPORT – A VM import created the image to use as the base image for the recipe.

          Possible values include:
          • "USER_INITIATED"
          • "SCHEDULED"
          • "IMPORT"
        • imageSource — (String)

          The origin of the base image that Image Builder used to build this image.

          Possible values include:
          • "AMAZON_MANAGED"
          • "AWS_MARKETPLACE"
          • "IMPORTED"
          • "CUSTOM"
        • deprecationTime — (Date)

          The time when deprecation occurs for an image resource. This can be a past or future date.

        • lifecycleExecutionId — (String)

          Identifies the last runtime instance of the lifecycle policy to take action on the image.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImagePackages(params = {}, callback) ⇒ AWS.Request

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Service Reference:

Examples:

Calling the listImagePackages operation

var params = {
  imageBuildVersionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImagePackages(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: {})
    • imageBuildVersionArn — (String)

      Filter results for the ListImagePackages request by the Image Build Version ARN

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePackageList — (Array<map>)

        The list of Image Packages returned in the response.

        • packageName — (String)

          The name of the package as reported to the operating system package manager.

        • packageVersion — (String)

          The version of the package as reported to the operating system package manager.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImagePipelineImages(params = {}, callback) ⇒ AWS.Request

Returns a list of images created by the specified pipeline.

Service Reference:

Examples:

Calling the listImagePipelineImages operation

var params = {
  imagePipelineArn: 'STRING_VALUE', /* required */
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImagePipelineImages(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: {})
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • version

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageSummaryList — (Array<map>)

        The list of images built by this pipeline.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image.

        • name — (String)

          The name of the image.

        • type — (String)

          Specifies whether this image produces an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          The version of the image.

        • platform — (String)

          The image operating system platform, such as Linux or Windows.

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • state — (map)

          The state of the image.

          • status — (String)

            The status of the image.

            Possible values include:
            • "PENDING"
            • "CREATING"
            • "BUILDING"
            • "TESTING"
            • "DISTRIBUTING"
            • "INTEGRATING"
            • "AVAILABLE"
            • "CANCELLED"
            • "FAILED"
            • "DEPRECATED"
            • "DELETED"
            • "DISABLED"
          • reason — (String)

            The reason for the status of the image.

        • owner — (String)

          The owner of the image.

        • dateCreated — (String)

          The date on which Image Builder created this image.

        • outputResources — (map)

          The output resources that Image Builder produced when it created this image.

          • amis — (Array<map>)

            The Amazon EC2 AMIs created by this image.

            • region — (String)

              The Amazon Web Services Region of the Amazon EC2 AMI.

            • image — (String)

              The AMI ID of the Amazon EC2 AMI.

            • name — (String)

              The name of the Amazon EC2 AMI.

            • description — (String)

              The description of the Amazon EC2 AMI. Minimum and maximum length are in characters.

            • state — (map)

              Image status and the reason for that status.

              • status — (String)

                The status of the image.

                Possible values include:
                • "PENDING"
                • "CREATING"
                • "BUILDING"
                • "TESTING"
                • "DISTRIBUTING"
                • "INTEGRATING"
                • "AVAILABLE"
                • "CANCELLED"
                • "FAILED"
                • "DEPRECATED"
                • "DELETED"
                • "DISABLED"
              • reason — (String)

                The reason for the status of the image.

            • accountId — (String)

              The account ID of the owner of the AMI.

          • containers — (Array<map>)

            Container images that the pipeline has generated and stored in the output repository.

            • region — (String)

              Containers and container images are Region-specific. This is the Region context for the container.

            • imageUris — (Array<String>)

              A list of URIs for containers created in the context Region.

        • tags — (map<String>)

          The tags that apply to this image.

        • buildType — (String)

          Indicates the type of build that created this image. The build can be initiated in the following ways:

          • USER_INITIATED – A manual pipeline build request.

          • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

          • IMPORT – A VM import created the image to use as the base image for the recipe.

          Possible values include:
          • "USER_INITIATED"
          • "SCHEDULED"
          • "IMPORT"
        • imageSource — (String)

          The origin of the base image that Image Builder used to build this image.

          Possible values include:
          • "AMAZON_MANAGED"
          • "AWS_MARKETPLACE"
          • "IMPORTED"
          • "CUSTOM"
        • deprecationTime — (Date)

          The time when deprecation occurs for an image resource. This can be a past or future date.

        • lifecycleExecutionId — (String)

          Identifies the last runtime instance of the lifecycle policy to take action on the image.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImagePipelines(params = {}, callback) ⇒ AWS.Request

Returns a list of image pipelines.

Service Reference:

Examples:

Calling the listImagePipelines operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImagePipelines(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: {})
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • description

      • distributionConfigurationArn

      • imageRecipeArn

      • infrastructureConfigurationArn

      • name

      • status

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imagePipelineList — (Array<map>)

        The list of image pipelines.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image pipeline.

        • name — (String)

          The name of the image pipeline.

        • description — (String)

          The description of the image pipeline.

        • platform — (String)

          The platform of the image pipeline.

          Possible values include:
          • "Windows"
          • "Linux"
        • enhancedImageMetadataEnabled — (Boolean)

          Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

        • imageRecipeArn — (String)

          The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

        • containerRecipeArn — (String)

          The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

        • infrastructureConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

        • distributionConfigurationArn — (String)

          The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

        • imageTestsConfiguration — (map)

          The image tests configuration of the image pipeline.

          • imageTestsEnabled — (Boolean)

            Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

          • timeoutMinutes — (Integer)

            The maximum time in minutes that tests are permitted to run.

            Note: The timeoutMinutes attribute is not currently active. This value is ignored.
        • schedule — (map)

          The schedule of the image pipeline.

          • scheduleExpression — (String)

            The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

            For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

          • timezone — (String)

            The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

          • pipelineExecutionStartCondition — (String)

            The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

            Possible values include:
            • "EXPRESSION_MATCH_ONLY"
            • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
        • status — (String)

          The status of the image pipeline.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • dateCreated — (String)

          The date on which this image pipeline was created.

        • dateUpdated — (String)

          The date on which this image pipeline was last updated.

        • dateLastRun — (String)

          This is no longer supported, and does not return a value.

        • dateNextRun — (String)

          The next date when the pipeline is scheduled to run.

        • tags — (map<String>)

          The tags of this image pipeline.

        • imageScanningConfiguration — (map)

          Contains settings for vulnerability scans.

          • imageScanningEnabled — (Boolean)

            A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

          • ecrConfiguration — (map)

            Contains Amazon ECR settings for vulnerability scans.

            • repositoryName — (String)

              The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

            • containerTags — (Array<String>)

              Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

        • executionRole — (String)

          The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

        • workflows — (Array<map>)

          Contains the workflows that run for the image pipeline.

          • workflowArnrequired — (String)

            The Amazon Resource Name (ARN) of the workflow resource.

          • parameters — (Array<map>)

            Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

            • namerequired — (String)

              The name of the workflow parameter to set.

            • valuerequired — (Array<String>)

              Sets the value for the named workflow parameter.

          • parallelGroup — (String)

            Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

          • onFailure — (String)

            The action to take if the workflow fails.

            Possible values include:
            • "CONTINUE"
            • "ABORT"
      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImageRecipes(params = {}, callback) ⇒ AWS.Request

Returns a list of image recipes.

Service Reference:

Examples:

Calling the listImageRecipes operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon | ThirdParty
};
imagebuilder.listImageRecipes(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: {})
    • owner — (String)

      The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
      • "ThirdParty"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • parentImage

      • platform

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeSummaryList — (Array<map>)

        The list of image pipelines.

        • arn — (String)

          The Amazon Resource Name (ARN) of the image recipe.

        • name — (String)

          The name of the image recipe.

        • platform — (String)

          The platform of the image recipe.

          Possible values include:
          • "Windows"
          • "Linux"
        • owner — (String)

          The owner of the image recipe.

        • parentImage — (String)

          The base image of the image recipe.

        • dateCreated — (String)

          The date on which this image recipe was created.

        • tags — (map<String>)

          The tags of the image recipe.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImages(params = {}, callback) ⇒ AWS.Request

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Service Reference:

Examples:

Calling the listImages operation

var params = {
  byName: true || false,
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  includeDeprecated: true || false,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon | ThirdParty
};
imagebuilder.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: {})
    • owner — (String)

      The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
      • "ThirdParty"
    • filters — (Array<map>)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • byName — (Boolean)

      Requests a list of images with a specific recipe name.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    • includeDeprecated — (Boolean)

      Includes deprecated images in the response list.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageVersionList — (Array<map>)

        The list of image semantic versions.

        Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • arn — (String)

          The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

          Note: Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:
          1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.
          2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>
          3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
        • name — (String)

          The name of this specific version of an Image Builder image.

        • type — (String)

          Specifies whether this image produces an AMI or a container image.

          Possible values include:
          • "AMI"
          • "DOCKER"
        • version — (String)

          Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

          Note: The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them. Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 230-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node. Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01. Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
        • platform — (String)

          The operating system platform of the image version, for example "Windows" or "Linux".

          Possible values include:
          • "Windows"
          • "Linux"
        • osVersion — (String)

          The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

        • owner — (String)

          The owner of the image version.

        • dateCreated — (String)

          The date on which this specific version of the Image Builder image was created.

        • buildType — (String)

          Indicates the type of build that created this image. The build can be initiated in the following ways:

          • USER_INITIATED – A manual pipeline build request.

          • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

          • IMPORT – A VM import created the image to use as the base image for the recipe.

          Possible values include:
          • "USER_INITIATED"
          • "SCHEDULED"
          • "IMPORT"
        • imageSource — (String)

          The origin of the base image that Image Builder used to build this image.

          Possible values include:
          • "AMAZON_MANAGED"
          • "AWS_MARKETPLACE"
          • "IMPORTED"
          • "CUSTOM"
      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImageScanFindingAggregations(params = {}, callback) ⇒ AWS.Request

Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.

To streamline results, you can use the following filters in your request:

  • accountId

  • imageBuildVersionArn

  • imagePipelineArn

  • vulnerabilityId

Examples:

Calling the listImageScanFindingAggregations operation

var params = {
  filter: {
    name: 'STRING_VALUE',
    values: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImageScanFindingAggregations(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: {})
    • filter — (map)

      A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • aggregationType — (String)

        The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn't specify a filter in the request, the type defaults to accountId.

        Aggregation types

        • accountId

        • imageBuildVersionArn

        • imagePipelineArn

        • vulnerabilityId

        Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.

      • responses — (Array<map>)

        An array of image scan finding aggregations that match the filter criteria.

        • accountAggregation — (map)

          Returns an object that contains severity counts based on an account ID.

          • accountId — (String)

            Identifies the account that owns the aggregated resource findings.

          • severityCounts — (map)

            Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.

            • all — (Integer)

              The total number of findings across all severity levels for the specified filter.

            • critical — (Integer)

              The number of critical severity findings for the specified filter.

            • high — (Integer)

              The number of high severity findings for the specified filter.

            • medium — (Integer)

              The number of medium severity findings for the specified filter.

        • imageAggregation — (map)

          Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.

          • imageBuildVersionArn — (String)

            The Amazon Resource Name (ARN) that identifies the image for this aggregation.

          • severityCounts — (map)

            Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.

            • all — (Integer)

              The total number of findings across all severity levels for the specified filter.

            • critical — (Integer)

              The number of critical severity findings for the specified filter.

            • high — (Integer)

              The number of high severity findings for the specified filter.

            • medium — (Integer)

              The number of medium severity findings for the specified filter.

        • imagePipelineAggregation — (map)

          Returns an object that contains severity counts based on an image pipeline ARN.

          • imagePipelineArn — (String)

            The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.

          • severityCounts — (map)

            Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.

            • all — (Integer)

              The total number of findings across all severity levels for the specified filter.

            • critical — (Integer)

              The number of critical severity findings for the specified filter.

            • high — (Integer)

              The number of high severity findings for the specified filter.

            • medium — (Integer)

              The number of medium severity findings for the specified filter.

        • vulnerabilityIdAggregation — (map)

          Returns an object that contains severity counts based on vulnerability ID.

          • vulnerabilityId — (String)

            The vulnerability Id for this set of counts.

          • severityCounts — (map)

            Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.

            • all — (Integer)

              The total number of findings across all severity levels for the specified filter.

            • critical — (Integer)

              The number of critical severity findings for the specified filter.

            • high — (Integer)

              The number of high severity findings for the specified filter.

            • medium — (Integer)

              The number of medium severity findings for the specified filter.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listImageScanFindings(params = {}, callback) ⇒ AWS.Request

Returns a list of image scan findings for your account.

Service Reference:

Examples:

Calling the listImageScanFindings operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listImageScanFindings(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: {})
    • filters — (Array<map>)

      An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:

      • imageBuildVersionArn

      • imagePipelineArn

      • vulnerabilityId

      • severity

      If you don't request a filter, then all findings in your account are listed.

      • name — (String)

        The name of the image scan finding filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • findings — (Array<map>)

        The image scan findings for your account that meet your request filter criteria.

        • awsAccountId — (String)

          The Amazon Web Services account ID that's associated with the finding.

        • imageBuildVersionArn — (String)

          The Amazon Resource Name (ARN) of the image build version that's associated with the finding.

        • imagePipelineArn — (String)

          The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding.

        • type — (String)

          The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.

        • description — (String)

          The description of the finding.

        • title — (String)

          The title of the finding.

        • remediation — (map)

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

          • recommendation — (map)

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

            • text — (String)

              The recommended course of action to remediate the finding.

            • url — (String)

              A link to more information about the recommended remediation for this vulnerability.

        • severity — (String)

          The severity of the finding.

        • firstObservedAt — (Date)

          The date and time when the finding was first observed.

        • updatedAt — (Date)

          The timestamp when the finding was last updated.

        • inspectorScore — (Float)

          The score that Amazon Inspector assigned for the finding.

        • inspectorScoreDetails — (map)

          An object that contains details of the Amazon Inspector score.

          • adjustedCvss — (map)

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

            • scoreSource — (String)

              The source for the CVSS score.

            • cvssSource — (String)

              The source of the finding.

            • version — (String)

              The CVSS version that generated the score.

            • score — (Float)

              The CVSS score.

            • scoringVector — (String)

              A vector that measures the severity of the vulnerability.

            • adjustments — (Array<map>)

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

              • metric — (String)

                The metric that Amazon Inspector used to adjust the CVSS score.

              • reason — (String)

                The reason for the CVSS score adjustment.

        • packageVulnerabilityDetails — (map)

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

          • vulnerabilityIdrequired — (String)

            A unique identifier for this vulnerability.

          • vulnerablePackages — (Array<map>)

            The packages that this vulnerability impacts.

            • name — (String)

              The name of the vulnerable package.

            • version — (String)

              The version of the vulnerable package.

            • sourceLayerHash — (String)

              The source layer hash of the vulnerable package.

            • epoch — (Integer)

              The epoch of the vulnerable package.

            • release — (String)

              The release of the vulnerable package.

            • arch — (String)

              The architecture of the vulnerable package.

            • packageManager — (String)

              The package manager of the vulnerable package.

            • filePath — (String)

              The file path of the vulnerable package.

            • fixedInVersion — (String)

              The version of the package that contains the vulnerability fix.

            • remediation — (String)

              The code to run in your environment to update packages with a fix available.

          • source — (String)

            The source of the vulnerability information.

          • cvss — (Array<map>)

            CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.

            • baseScore — (Float)

              The CVSS base score.

            • scoringVector — (String)

              The vector string of the CVSS score.

            • version — (String)

              The CVSS version that generated the score.

            • source — (String)

              The source of the CVSS score.

          • relatedVulnerabilities — (Array<String>)

            Vulnerabilities that are often related to the findings for the package.

          • sourceUrl — (String)

            A link to the source of the vulnerability information.

          • vendorSeverity — (String)

            The severity that the vendor assigned to this vulnerability type.

          • vendorCreatedAt — (Date)

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

          • vendorUpdatedAt — (Date)

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

          • referenceUrls — (Array<String>)

            Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.

        • fixAvailable — (String)

          Details about whether a fix is available for any of the packages that are identified in the finding through a version update.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listInfrastructureConfigurations(params = {}, callback) ⇒ AWS.Request

Returns a list of infrastructure configurations.

Examples:

Calling the listInfrastructureConfigurations operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listInfrastructureConfigurations(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: {})
    • filters — (Array<map>)

      You can filter on name to streamline results.

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • infrastructureConfigurationSummaryList — (Array<map>)

        The list of infrastructure configurations.

        • arn — (String)

          The Amazon Resource Name (ARN) of the infrastructure configuration.

        • name — (String)

          The name of the infrastructure configuration.

        • description — (String)

          The description of the infrastructure configuration.

        • dateCreated — (String)

          The date on which the infrastructure configuration was created.

        • dateUpdated — (String)

          The date on which the infrastructure configuration was last updated.

        • resourceTags — (map<String>)

          The tags attached to the image created by Image Builder.

        • tags — (map<String>)

          The tags of the infrastructure configuration.

        • instanceTypes — (Array<String>)

          The instance types of the infrastructure configuration.

        • instanceProfileName — (String)

          The instance profile of the infrastructure configuration.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listLifecycleExecutionResources(params = {}, callback) ⇒ AWS.Request

List resources that the runtime instance of the image lifecycle identified for lifecycle actions.

Service Reference:

Examples:

Calling the listLifecycleExecutionResources operation

var params = {
  lifecycleExecutionId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  parentResourceId: 'STRING_VALUE'
};
imagebuilder.listLifecycleExecutionResources(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: {})
    • lifecycleExecutionId — (String)

      Use the unique identifier for a runtime instance of the lifecycle policy to get runtime details.

    • parentResourceId — (String)

      You can leave this empty to get a list of Image Builder resources that were identified for lifecycle actions.

      To get a list of associated resources that are impacted for an individual resource (the parent), specify its Amazon Resource Name (ARN). Associated resources are produced from your image and distributed when you run a build, such as AMIs or container images stored in ECR repositories.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • lifecycleExecutionId — (String)

        Runtime details for the specified runtime instance of the lifecycle policy.

      • lifecycleExecutionState — (map)

        The current state of the lifecycle runtime instance.

        • status — (String)

          The runtime status of the lifecycle execution.

          Possible values include:
          • "IN_PROGRESS"
          • "CANCELLED"
          • "CANCELLING"
          • "FAILED"
          • "SUCCESS"
          • "PENDING"
        • reason — (String)

          The reason for the current status.

      • resources — (Array<map>)

        A list of resources that were identified for lifecycle actions.

        • accountId — (String)

          The account that owns the impacted resource.

        • resourceId — (String)

          Identifies the impacted resource. The resource ID depends on the type of resource, as follows.

          • Image Builder image resources: Amazon Resource Name (ARN)

          • Distributed AMIs: AMI ID

          • Container images distributed to an ECR repository: image URI or SHA Digest

        • state — (map)

          The runtime state for the lifecycle execution.

          • status — (String)

            The runtime status of the lifecycle action taken for the impacted resource.

            Possible values include:
            • "FAILED"
            • "IN_PROGRESS"
            • "SKIPPED"
            • "SUCCESS"
          • reason — (String)

            Messaging that clarifies the reason for the assigned status.

        • action — (map)

          The action to take for the identified resource.

          • name — (String)

            The name of the resource that was identified for a lifecycle policy action.

            Possible values include:
            • "AVAILABLE"
            • "DELETE"
            • "DEPRECATE"
            • "DISABLE"
          • reason — (String)

            The reason why the lifecycle policy action is taken.

        • region — (String)

          The Amazon Web Services Region where the lifecycle execution resource is stored.

        • snapshots — (Array<map>)

          A list of associated resource snapshots for the impacted resource if it’s an AMI.

          • snapshotId — (String)

            Identifies the impacted snapshot resource.

          • state — (map)

            The runtime status of the lifecycle action taken for the snapshot.

            • status — (String)

              The runtime status of the lifecycle action taken for the impacted resource.

              Possible values include:
              • "FAILED"
              • "IN_PROGRESS"
              • "SKIPPED"
              • "SUCCESS"
            • reason — (String)

              Messaging that clarifies the reason for the assigned status.

        • imageUris — (Array<String>)

          For an impacted container image, this identifies a list of URIs for associated container images distributed to ECR repositories.

        • startTime — (Date)

          The starting timestamp from the lifecycle action that was applied to the resource.

        • endTime — (Date)

          The ending timestamp from the lifecycle action that was applied to the resource.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listLifecycleExecutions(params = {}, callback) ⇒ AWS.Request

Get the lifecycle runtime history for the specified resource.

Service Reference:

Examples:

Calling the listLifecycleExecutions operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listLifecycleExecutions(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: {})
    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource for which to get a list of lifecycle runtime instances.

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:

      • lifecycleExecutions — (Array<map>)

        A list of lifecycle runtime instances for the specified resource.

        • lifecycleExecutionId — (String)

          Identifies the lifecycle policy runtime instance.

        • lifecyclePolicyArn — (String)

          The Amazon Resource Name (ARN) of the lifecycle policy that ran.

        • resourcesImpactedSummary — (map)

          Contains information about associated resources that are identified for action by the runtime instance of the lifecycle policy.

          • hasImpactedResources — (Boolean)

            Indicates whether an image resource that was identified for a lifecycle action has associated resources that are also impacted.

        • state — (map)

          Runtime state that reports if the policy action ran successfully, failed, or was skipped.

          • status — (String)

            The runtime status of the lifecycle execution.

            Possible values include:
            • "IN_PROGRESS"
            • "CANCELLED"
            • "CANCELLING"
            • "FAILED"
            • "SUCCESS"
            • "PENDING"
          • reason — (String)

            The reason for the current status.

        • startTime — (Date)

          The timestamp when the lifecycle runtime instance started.

        • endTime — (Date)

          The timestamp when the lifecycle runtime instance completed.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listLifecyclePolicies(params = {}, callback) ⇒ AWS.Request

Get a list of lifecycle policies in your Amazon Web Services account.

Service Reference:

Examples:

Calling the listLifecyclePolicies operation

var params = {
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listLifecyclePolicies(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: {})
    • filters — (Array<map>)

      Streamline results based on one of the following values: Name, Status.

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • lifecyclePolicySummaryList — (Array<map>)

        A list of lifecycle policies in your Amazon Web Services account that meet the criteria specified in the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the lifecycle policy summary resource.

        • name — (String)

          The name of the lifecycle policy.

        • description — (String)

          Optional description for the lifecycle policy.

        • status — (String)

          The lifecycle policy resource status.

          Possible values include:
          • "DISABLED"
          • "ENABLED"
        • executionRole — (String)

          The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to run the lifecycle policy.

        • resourceType — (String)

          The type of resources the lifecycle policy targets.

          Possible values include:
          • "AMI_IMAGE"
          • "CONTAINER_IMAGE"
        • dateCreated — (Date)

          The timestamp when Image Builder created the lifecycle policy resource.

        • dateUpdated — (Date)

          The timestamp when Image Builder updated the lifecycle policy resource.

        • dateLastRun — (Date)

          The timestamp for the last time Image Builder ran the lifecycle policy.

        • tags — (map<String>)

          To help manage your lifecycle policy resources, you can assign your own metadata to each resource in the form of tags. Each tag consists of a key and an optional value, both of which you define.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns the list of tags for the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
imagebuilder.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) of the resource whose tags you want 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:

      • tags — (map<String>)

        The tags for the specified resource.

Returns:

  • (AWS.Request)

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

listWaitingWorkflowSteps(params = {}, callback) ⇒ AWS.Request

Get a list of workflow steps that are waiting for action for workflows in your Amazon Web Services account.

Service Reference:

Examples:

Calling the listWaitingWorkflowSteps operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listWaitingWorkflowSteps(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: {})
    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • steps — (Array<map>)

        An array of the workflow steps that are waiting for action in your Amazon Web Services account.

        • stepExecutionId — (String)

          Uniquely identifies the workflow step that ran for the associated image build version.

        • imageBuildVersionArn — (String)

          The Amazon Resource Name (ARN) of the image build version that ran the workflow.

        • workflowExecutionId — (String)

          Uniquely identifies the runtime instance of the workflow that contains the workflow step that ran for the associated image build version.

        • workflowBuildVersionArn — (String)

          The ARN of the workflow resource that ran.

        • name — (String)

          The name of the workflow step.

        • action — (String)

          The name of the step action.

        • startTime — (String)

          The timestamp when the workflow step started.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listWorkflowBuildVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of build versions for a specific workflow resource.

Service Reference:

Examples:

Calling the listWorkflowBuildVersions operation

var params = {
  workflowVersionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listWorkflowBuildVersions(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: {})
    • workflowVersionArn — (String)

      The Amazon Resource Name (ARN) of the workflow resource for which to get a list of build versions.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • workflowSummaryList — (Array<map>)

        A list that contains metadata for the workflow builds that have run for the workflow resource specified in the request.

        • arn — (String)

          The Amazon Resource Name (ARN) of the workflow resource.

        • name — (String)

          The name of the workflow.

        • version — (String)

          The version of the workflow.

        • description — (String)

          Describes the workflow.

        • changeDescription — (String)

          The change description for the current version of the workflow resource.

        • type — (String)

          The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

          Possible values include:
          • "BUILD"
          • "TEST"
          • "DISTRIBUTION"
        • owner — (String)

          The owner of the workflow resource.

        • state — (map)

          Describes the current state of the workflow resource.

          • status — (String)

            The current state of the workflow.

            Possible values include:
            • "DEPRECATED"
          • reason — (String)

            Describes how or why the workflow changed state.

        • dateCreated — (String)

          The original creation date of the workflow resource.

        • tags — (map<String>)

          Contains a list of tags that are defined for the workflow.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listWorkflowExecutions(params = {}, callback) ⇒ AWS.Request

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Service Reference:

Examples:

Calling the listWorkflowExecutions operation

var params = {
  imageBuildVersionArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listWorkflowExecutions(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: {})
    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    • imageBuildVersionArn — (String)

      List all workflow runtime instances for the specified image build version resource ARN.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • workflowExecutions — (Array<map>)

        Contains an array of runtime details that represents each time a workflow ran for the requested image build version.

        • workflowBuildVersionArn — (String)

          The Amazon Resource Name (ARN) of the workflow resource build version that ran.

        • workflowExecutionId — (String)

          Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

        • type — (String)

          Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

          Possible values include:
          • "BUILD"
          • "TEST"
          • "DISTRIBUTION"
        • status — (String)

          The current runtime status for this workflow.

          Possible values include:
          • "PENDING"
          • "SKIPPED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
          • "ROLLBACK_IN_PROGRESS"
          • "ROLLBACK_COMPLETED"
          • "CANCELLED"
        • message — (String)

          The runtime output message from the workflow, if applicable.

        • totalStepCount — (Integer)

          The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

        • totalStepsSucceeded — (Integer)

          A runtime count for the number of steps in the workflow that ran successfully.

        • totalStepsFailed — (Integer)

          A runtime count for the number of steps in the workflow that failed.

        • totalStepsSkipped — (Integer)

          A runtime count for the number of steps in the workflow that were skipped.

        • startTime — (String)

          The timestamp when the runtime instance of this workflow started.

        • endTime — (String)

          The timestamp when this runtime instance of the workflow finished.

        • parallelGroup — (String)

          The name of the test group that included the test workflow resource at runtime.

      • imageBuildVersionArn — (String)

        The resource ARN of the image build version for which you requested a list of workflow runtime details.

      • message — (String)

        The output message from the list action, if applicable.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listWorkflows(params = {}, callback) ⇒ AWS.Request

Lists workflow build versions based on filtering parameters.

Service Reference:

Examples:

Calling the listWorkflows operation

var params = {
  byName: true || false,
  filters: [
    {
      name: 'STRING_VALUE',
      values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owner: Self | Shared | Amazon | ThirdParty
};
imagebuilder.listWorkflows(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: {})
    • owner — (String)

      Used to get a list of workflow build version filtered by the identity of the creator.

      Possible values include:
      • "Self"
      • "Shared"
      • "Amazon"
      • "ThirdParty"
    • filters — (Array<map>)

      Used to streamline search results.

      • name — (String)

        The name of the filter. Filter names are case-sensitive.

      • values — (Array<String>)

        The filter values. Filter values are case-sensitive.

    • byName — (Boolean)

      Specify all or part of the workflow name to streamline results.

    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

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:

      • workflowVersionList — (Array<map>)

        A list of workflow build versions that match the request criteria.

        • arn — (String)

          The Amazon Resource Name (ARN) of the workflow resource.

        • name — (String)

          The name of the workflow.

        • version — (String)

          The semantic version of the workflow resource. The format includes three nodes: <major>.<minor>.<patch>.

        • description — (String)

          Describes the workflow.

        • type — (String)

          The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

          Possible values include:
          • "BUILD"
          • "TEST"
          • "DISTRIBUTION"
        • owner — (String)

          The owner of the workflow resource.

        • dateCreated — (String)

          The timestamp when Image Builder created the workflow version.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

listWorkflowStepExecutions(params = {}, callback) ⇒ AWS.Request

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

Service Reference:

Examples:

Calling the listWorkflowStepExecutions operation

var params = {
  workflowExecutionId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
imagebuilder.listWorkflowStepExecutions(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: {})
    • maxResults — (Integer)

      The maximum items to return in a request.

    • nextToken — (String)

      A token to specify where to start paginating. This is the nextToken from a previously truncated response.

    • workflowExecutionId — (String)

      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • steps — (Array<map>)

        Contains an array of runtime details that represents each step in this runtime instance of the workflow.

        • stepExecutionId — (String)

          A unique identifier for the workflow step, assigned at runtime.

        • name — (String)

          The name of the workflow step.

        • description — (String)

          Description of the workflow step.

        • action — (String)

          The step action name.

        • status — (String)

          Runtime status for the workflow step.

          Possible values include:
          • "PENDING"
          • "SKIPPED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
          • "CANCELLED"
        • rollbackStatus — (String)

          Reports on the rollback status of the step, if applicable.

          Possible values include:
          • "RUNNING"
          • "COMPLETED"
          • "SKIPPED"
          • "FAILED"
        • message — (String)

          Detailed output message that the workflow step provides at runtime.

        • inputs — (String)

          Input parameters that Image Builder provides for the workflow step.

        • outputs — (String)

          The file names that the workflow step created as output for this runtime instance of the workflow.

        • startTime — (String)

          The timestamp when the workflow step started.

        • endTime — (String)

          The timestamp when the workflow step finished.

      • workflowBuildVersionArn — (String)

        The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

      • workflowExecutionId — (String)

        The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      • imageBuildVersionArn — (String)

        The image build version resource ARN that's associated with the specified runtime instance of the workflow.

      • message — (String)

        The output message from the list action, if applicable.

      • nextToken — (String)

        The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

Returns:

  • (AWS.Request)

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

putComponentPolicy(params = {}, callback) ⇒ AWS.Request

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putComponentPolicy operation

var params = {
  componentArn: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE' /* required */
};
imagebuilder.putComponentPolicy(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: {})
    • componentArn — (String)

      The Amazon Resource Name (ARN) of the component that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • componentArn — (String)

        The Amazon Resource Name (ARN) of the component that this policy was applied to.

Returns:

  • (AWS.Request)

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

putContainerRecipePolicy(params = {}, callback) ⇒ AWS.Request

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putContainerRecipePolicy operation

var params = {
  containerRecipeArn: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE' /* required */
};
imagebuilder.putContainerRecipePolicy(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: {})
    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

    • policy — (String)

      The policy to apply to the container recipe.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • containerRecipeArn — (String)

        The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

Returns:

  • (AWS.Request)

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

putImagePolicy(params = {}, callback) ⇒ AWS.Request

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putImagePolicy operation

var params = {
  imageArn: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE' /* required */
};
imagebuilder.putImagePolicy(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: {})
    • imageArn — (String)

      The Amazon Resource Name (ARN) of the image that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageArn — (String)

        The Amazon Resource Name (ARN) of the image that this policy was applied to.

Returns:

  • (AWS.Request)

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

putImageRecipePolicy(params = {}, callback) ⇒ AWS.Request

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Service Reference:

Examples:

Calling the putImageRecipePolicy operation

var params = {
  imageRecipeArn: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE' /* required */
};
imagebuilder.putImageRecipePolicy(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: {})
    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

    • policy — (String)

      The policy to apply.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • imageRecipeArn — (String)

        The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

Returns:

  • (AWS.Request)

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

sendWorkflowStepAction(params = {}, callback) ⇒ AWS.Request

Pauses or resumes image creation when the associated workflow runs a WaitForAction step.

Service Reference:

Examples:

Calling the sendWorkflowStepAction operation

var params = {
  action: RESUME | STOP, /* required */
  clientToken: 'STRING_VALUE', /* required */
  imageBuildVersionArn: 'STRING_VALUE', /* required */
  stepExecutionId: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE'
};
imagebuilder.sendWorkflowStepAction(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: {})
    • stepExecutionId — (String)

      Uniquely identifies the workflow step that sent the step action.

    • imageBuildVersionArn — (String)

      The Amazon Resource Name (ARN) of the image build version to send action for.

    • action — (String)

      The action for the image creation process to take while a workflow WaitForAction step waits for an asynchronous action to complete.

      Possible values include:
      • "RESUME"
      • "STOP"
    • reason — (String)

      The reason why this action is sent.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • stepExecutionId — (String)

        The workflow step that sent the step action.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image build version that received the action request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

Returns:

  • (AWS.Request)

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

startImagePipelineExecution(params = {}, callback) ⇒ AWS.Request

Manually triggers a pipeline to create an image.

Service Reference:

Examples:

Calling the startImagePipelineExecution operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imagePipelineArn: 'STRING_VALUE' /* required */
};
imagebuilder.startImagePipelineExecution(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: {})
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imageBuildVersionArn — (String)

        The Amazon Resource Name (ARN) of the image that the request created.

Returns:

  • (AWS.Request)

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

startResourceStateUpdate(params = {}, callback) ⇒ AWS.Request

Begin asynchronous resource state update for lifecycle changes to the specified image resources.

Service Reference:

Examples:

Calling the startResourceStateUpdate operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE', /* required */
  state: { /* required */
    status: AVAILABLE | DELETED | DEPRECATED | DISABLED
  },
  exclusionRules: {
    amis: {
      isPublic: true || false,
      lastLaunched: {
        unit: DAYS | WEEKS | MONTHS | YEARS, /* required */
        value: 'NUMBER_VALUE' /* required */
      },
      regions: [
        'STRING_VALUE',
        /* more items */
      ],
      sharedAccounts: [
        'STRING_VALUE',
        /* more items */
      ],
      tagMap: {
        '<TagKey>': 'STRING_VALUE',
        /* '<TagKey>': ... */
      }
    }
  },
  executionRole: 'STRING_VALUE',
  includeResources: {
    amis: true || false,
    containers: true || false,
    snapshots: true || false
  },
  updateAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
imagebuilder.startResourceStateUpdate(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 ARN of the Image Builder resource that is updated. The state update might also impact associated resources.

    • state — (map)

      Indicates the lifecycle action to take for this request.

      • status — (String)

        Shows the current lifecycle policy action that was applied to an impacted resource.

        Possible values include:
        • "AVAILABLE"
        • "DELETED"
        • "DEPRECATED"
        • "DISABLED"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) of the IAM role that’s used to update image state.

    • includeResources — (map)

      A list of image resources to update state for.

      • amis — (Boolean)

        Specifies whether the lifecycle action should apply to distributed AMIs

      • snapshots — (Boolean)

        Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

      • containers — (Boolean)

        Specifies whether the lifecycle action should apply to distributed containers.

    • exclusionRules — (map)

      Skip action on the image resource and associated resources if specified exclusion rules are met.

      • amis — (map)

        Defines criteria for AMIs that are excluded from lifecycle actions.

        • isPublic — (Boolean)

          Configures whether public AMIs are excluded from the lifecycle action.

        • regions — (Array<String>)

          Configures Amazon Web Services Regions that are excluded from the lifecycle action.

        • sharedAccounts — (Array<String>)

          Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.

        • lastLaunched — (map)

          Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

          • valuerequired — (Integer)

            The integer number of units for the time period. For example 6 (months).

          • unitrequired — (String)

            Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.

            Possible values include:
            • "DAYS"
            • "WEEKS"
            • "MONTHS"
            • "YEARS"
        • tagMap — (map<String>)

          Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

    • updateAt — (Date)

      The timestamp that indicates when resources are updated by a lifecycle action.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • lifecycleExecutionId — (String)

        Identifies the lifecycle runtime instance that started the resource state update.

      • resourceArn — (String)

        The requested ARN of the Image Builder resource for the asynchronous update.

Returns:

  • (AWS.Request)

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

tagResource(params = {}, callback) ⇒ AWS.Request

Adds a tag to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
imagebuilder.tagResource(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) of the resource that you want to tag.

    • tags — (map<String>)

      The tags to apply to the resource.

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.

Returns:

  • (AWS.Request)

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a tag from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
imagebuilder.untagResource(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) of the resource that you want to untag.

    • tagKeys — (Array<String>)

      The tag keys to remove from the resource.

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.

Returns:

  • (AWS.Request)

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

updateDistributionConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.

Service Reference:

Examples:

Calling the updateDistributionConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  distributionConfigurationArn: 'STRING_VALUE', /* required */
  distributions: [ /* required */
    {
      region: 'STRING_VALUE', /* required */
      amiDistributionConfiguration: {
        amiTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        description: 'STRING_VALUE',
        kmsKeyId: 'STRING_VALUE',
        launchPermission: {
          organizationArns: [
            'STRING_VALUE',
            /* more items */
          ],
          organizationalUnitArns: [
            'STRING_VALUE',
            /* more items */
          ],
          userGroups: [
            'STRING_VALUE',
            /* more items */
          ],
          userIds: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        name: 'STRING_VALUE',
        targetAccountIds: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      containerDistributionConfiguration: {
        targetRepository: { /* required */
          repositoryName: 'STRING_VALUE', /* required */
          service: ECR /* required */
        },
        containerTags: [
          'STRING_VALUE',
          /* more items */
        ],
        description: 'STRING_VALUE'
      },
      fastLaunchConfigurations: [
        {
          enabled: true || false, /* required */
          accountId: 'STRING_VALUE',
          launchTemplate: {
            launchTemplateId: 'STRING_VALUE',
            launchTemplateName: 'STRING_VALUE',
            launchTemplateVersion: 'STRING_VALUE'
          },
          maxParallelLaunches: 'NUMBER_VALUE',
          snapshotConfiguration: {
            targetResourceCount: 'NUMBER_VALUE'
          }
        },
        /* more items */
      ],
      launchTemplateConfigurations: [
        {
          launchTemplateId: 'STRING_VALUE', /* required */
          accountId: 'STRING_VALUE',
          setDefaultVersion: true || false
        },
        /* more items */
      ],
      licenseConfigurationArns: [
        'STRING_VALUE',
        /* more items */
      ],
      s3ExportConfiguration: {
        diskImageFormat: VMDK | RAW | VHD, /* required */
        roleName: 'STRING_VALUE', /* required */
        s3Bucket: 'STRING_VALUE', /* required */
        s3Prefix: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  description: 'STRING_VALUE'
};
imagebuilder.updateDistributionConfiguration(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: {})
    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

    • description — (String)

      The description of the distribution configuration.

    • distributions — (Array<map>)

      The distributions of the distribution configuration.

      • regionrequired — (String)

        The target Region.

      • amiDistributionConfiguration — (map)

        The specific AMI settings; for example, launch permissions or AMI tags.

        • name — (String)

          The name of the output AMI.

        • description — (String)

          The description of the AMI distribution configuration. Minimum and maximum length are in characters.

        • targetAccountIds — (Array<String>)

          The ID of an account to which you want to distribute an image.

        • amiTags — (map<String>)

          The tags to apply to AMIs distributed to this Region.

        • kmsKeyId — (String)

          The KMS key identifier used to encrypt the distributed image.

        • launchPermission — (map)

          Launch permissions can be used to configure which Amazon Web Services accounts can use the AMI to launch instances.

          • userIds — (Array<String>)

            The Amazon Web Services account ID.

          • userGroups — (Array<String>)

            The name of the group.

          • organizationArns — (Array<String>)

            The ARN for an Amazon Web Services Organization that you want to share your AMI with. For more information, see What is Organizations?.

          • organizationalUnitArns — (Array<String>)

            The ARN for an Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for Organizations, see Organizations terminology and concepts.

      • containerDistributionConfiguration — (map)

        Container distribution settings for encryption, licensing, and sharing in a specific Region.

        • description — (String)

          The description of the container distribution configuration.

        • containerTags — (Array<String>)

          Tags that are attached to the container distribution configuration.

        • targetRepositoryrequired — (map)

          The destination repository for the container distribution configuration.

          • servicerequired — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryNamerequired — (String)

            The name of the container repository where the output container image is stored. This name is prefixed by the repository location.

      • licenseConfigurationArns — (Array<String>)

        The License Manager Configuration to associate with the AMI in the specified Region.

      • launchTemplateConfigurations — (Array<map>)

        A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

        • launchTemplateIdrequired — (String)

          Identifies the Amazon EC2 launch template to use.

        • accountId — (String)

          The account ID that this configuration applies to.

        • setDefaultVersion — (Boolean)

          Set the specified Amazon EC2 launch template as the default launch template for the specified account.

      • s3ExportConfiguration — (map)

        Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.

        • roleNamerequired — (String)

          The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

        • diskImageFormatrequired — (String)

          Export the updated image to one of the following supported disk image formats:

          • Virtual Hard Disk (VHD) – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.

          • Stream-optimized ESX Virtual Machine Disk (VMDK) – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.

          • Raw – Raw format.

          Possible values include:
          • "VMDK"
          • "RAW"
          • "VHD"
        • s3Bucketrequired — (String)

          The S3 bucket in which to store the output disk images for your VM.

        • s3Prefix — (String)

          The Amazon S3 path for the bucket where the output disk images for your VM are stored.

      • fastLaunchConfigurations — (Array<map>)

        The Windows faster-launching configurations to use for AMI distribution.

        • enabledrequired — (Boolean)

          A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

        • snapshotConfiguration — (map)

          Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

          • targetResourceCount — (Integer)

            The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

        • maxParallelLaunches — (Integer)

          The maximum number of parallel instances that are launched for creating resources.

        • launchTemplate — (map)

          The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

          • launchTemplateId — (String)

            The ID of the launch template to use for faster launching for a Windows AMI.

          • launchTemplateName — (String)

            The name of the launch template to use for faster launching for a Windows AMI.

          • launchTemplateVersion — (String)

            The version of the launch template to use for faster launching for a Windows AMI.

        • accountId — (String)

          The owner account ID for the fast-launch enabled Windows AMI.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • distributionConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.

Returns:

  • (AWS.Request)

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

updateImagePipeline(params = {}, callback) ⇒ AWS.Request

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

Note: UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

Service Reference:

Examples:

Calling the updateImagePipeline operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  imagePipelineArn: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  containerRecipeArn: 'STRING_VALUE',
  description: 'STRING_VALUE',
  distributionConfigurationArn: 'STRING_VALUE',
  enhancedImageMetadataEnabled: true || false,
  executionRole: 'STRING_VALUE',
  imageRecipeArn: 'STRING_VALUE',
  imageScanningConfiguration: {
    ecrConfiguration: {
      containerTags: [
        'STRING_VALUE',
        /* more items */
      ],
      repositoryName: 'STRING_VALUE'
    },
    imageScanningEnabled: true || false
  },
  imageTestsConfiguration: {
    imageTestsEnabled: true || false,
    timeoutMinutes: 'NUMBER_VALUE'
  },
  schedule: {
    pipelineExecutionStartCondition: EXPRESSION_MATCH_ONLY | EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE,
    scheduleExpression: 'STRING_VALUE',
    timezone: 'STRING_VALUE'
  },
  status: DISABLED | ENABLED,
  workflows: [
    {
      workflowArn: 'STRING_VALUE', /* required */
      onFailure: CONTINUE | ABORT,
      parallelGroup: 'STRING_VALUE',
      parameters: [
        {
          name: 'STRING_VALUE', /* required */
          value: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
imagebuilder.updateImagePipeline(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: {})
    • imagePipelineArn — (String)

      The Amazon Resource Name (ARN) of the image pipeline that you want to update.

    • description — (String)

      The description of the image pipeline.

    • imageRecipeArn — (String)

      The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

    • containerRecipeArn — (String)

      The Amazon Resource Name (ARN) of the container pipeline to update.

    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

    • distributionConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

    • imageTestsConfiguration — (map)

      The image test configuration of the image pipeline.

      • imageTestsEnabled — (Boolean)

        Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

      • timeoutMinutes — (Integer)

        The maximum time in minutes that tests are permitted to run.

        Note: The timeoutMinutes attribute is not currently active. This value is ignored.
    • enhancedImageMetadataEnabled — (Boolean)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

    • schedule — (map)

      The schedule of the image pipeline.

      • scheduleExpression — (String)

        The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

        For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

      • timezone — (String)

        The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

      • pipelineExecutionStartCondition — (String)

        The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

        Possible values include:
        • "EXPRESSION_MATCH_ONLY"
        • "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
    • status — (String)

      The status of the image pipeline.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.
    • imageScanningConfiguration — (map)

      Contains settings for vulnerability scans.

      • imageScanningEnabled — (Boolean)

        A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

      • ecrConfiguration — (map)

        Contains Amazon ECR settings for vulnerability scans.

        • repositoryName — (String)

          The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

        • containerTags — (Array<String>)

          Tags for Image Builder to apply to the output container image that &INS; scans. Tags can help you identify and manage your scanned images.

    • workflows — (Array<map>)

      Contains the workflows to run for the pipeline.

      • workflowArnrequired — (String)

        The Amazon Resource Name (ARN) of the workflow resource.

      • parameters — (Array<map>)

        Contains parameter values for each of the parameters that the workflow document defined for the workflow resource.

        • namerequired — (String)

          The name of the workflow parameter to set.

        • valuerequired — (Array<String>)

          Sets the value for the named workflow parameter.

      • parallelGroup — (String)

        Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

      • onFailure — (String)

        The action to take if the workflow fails.

        Possible values include:
        • "CONTINUE"
        • "ABORT"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • imagePipelineArn — (String)

        The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.

Returns:

  • (AWS.Request)

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

updateInfrastructureConfiguration(params = {}, callback) ⇒ AWS.Request

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Examples:

Calling the updateInfrastructureConfiguration operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  infrastructureConfigurationArn: 'STRING_VALUE', /* required */
  instanceProfileName: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  instanceMetadataOptions: {
    httpPutResponseHopLimit: 'NUMBER_VALUE',
    httpTokens: 'STRING_VALUE'
  },
  instanceTypes: [
    'STRING_VALUE',
    /* more items */
  ],
  keyPair: 'STRING_VALUE',
  logging: {
    s3Logs: {
      s3BucketName: 'STRING_VALUE',
      s3KeyPrefix: 'STRING_VALUE'
    }
  },
  resourceTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  snsTopicArn: 'STRING_VALUE',
  subnetId: 'STRING_VALUE',
  terminateInstanceOnFailure: true || false
};
imagebuilder.updateInfrastructureConfiguration(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: {})
    • infrastructureConfigurationArn — (String)

      The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

    • description — (String)

      The description of the infrastructure configuration.

    • instanceTypes — (Array<String>)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

    • instanceProfileName — (String)

      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • securityGroupIds — (Array<String>)

      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • subnetId — (String)

      The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

    • logging — (map)

      The logging configuration of the infrastructure configuration.

      • s3Logs — (map)

        The Amazon S3 logging configuration.

        • s3BucketName — (String)

          The S3 bucket in which to store the logs.

        • s3KeyPrefix — (String)

          The Amazon S3 path to the bucket where the logs are stored.

    • keyPair — (String)

      The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

    • terminateInstanceOnFailure — (Boolean)

      The terminate instance on failure setting of the infrastructure configuration. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

    • snsTopicArn — (String)

      The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

      Note: EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.
    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.
    • resourceTags — (map<String>)

      The tags attached to the resource created by Image Builder.

    • instanceMetadataOptions — (map)

      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

      • httpTokens — (String)

        Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

        • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.

        • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

        The default setting is optional.

      • httpPutResponseHopLimit — (Integer)

        Limit the number of hops that an instance metadata request can traverse to reach its destination. The default is one hop. However, if HTTP tokens are required, container image builds need a minimum of two hops.

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:

      • requestId — (String)

        The request ID that uniquely identifies this request.

      • clientToken — (String)

        The client token that uniquely identifies the request.

      • infrastructureConfigurationArn — (String)

        The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

Returns:

  • (AWS.Request)

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

updateLifecyclePolicy(params = {}, callback) ⇒ AWS.Request

Update the specified lifecycle policy.

Service Reference:

Examples:

Calling the updateLifecyclePolicy operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  executionRole: 'STRING_VALUE', /* required */
  lifecyclePolicyArn: 'STRING_VALUE', /* required */
  policyDetails: [ /* required */
    {
      action: { /* required */
        type: DELETE | DEPRECATE | DISABLE, /* required */
        includeResources: {
          amis: true || false,
          containers: true || false,
          snapshots: true || false
        }
      },
      filter: { /* required */
        type: AGE | COUNT, /* required */
        value: 'NUMBER_VALUE', /* required */
        retainAtLeast: 'NUMBER_VALUE',
        unit: DAYS | WEEKS | MONTHS | YEARS
      },
      exclusionRules: {
        amis: {
          isPublic: true || false,
          lastLaunched: {
            unit: DAYS | WEEKS | MONTHS | YEARS, /* required */
            value: 'NUMBER_VALUE' /* required */
          },
          regions: [
            'STRING_VALUE',
            /* more items */
          ],
          sharedAccounts: [
            'STRING_VALUE',
            /* more items */
          ],
          tagMap: {
            '<TagKey>': 'STRING_VALUE',
            /* '<TagKey>': ... */
          }
        },
        tagMap: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        }
      }
    },
    /* more items */
  ],
  resourceSelection: { /* required */
    recipes: [
      {
        name: 'STRING_VALUE', /* required */
        semanticVersion: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    tagMap: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  resourceType: AMI_IMAGE | CONTAINER_IMAGE, /* required */
  description: 'STRING_VALUE',
  status: DISABLED | ENABLED
};
imagebuilder.updateLifecyclePolicy(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: {})
    • lifecyclePolicyArn — (String)

      The Amazon Resource Name (ARN) of the lifecycle policy resource.

    • description — (String)

      Optional description for the lifecycle policy.

    • status — (String)

      Indicates whether the lifecycle policy resource is enabled.

      Possible values include:
      • "DISABLED"
      • "ENABLED"
    • executionRole — (String)

      The name or Amazon Resource Name (ARN) of the IAM role that Image Builder uses to update the lifecycle policy.

    • resourceType — (String)

      The type of image resource that the lifecycle policy applies to.

      Possible values include:
      • "AMI_IMAGE"
      • "CONTAINER_IMAGE"
    • policyDetails — (Array<map>)

      The configuration details for a lifecycle policy resource.

      • actionrequired — (map)

        Configuration details for the policy action.

        • typerequired — (String)

          Specifies the lifecycle action to take.

          Possible values include:
          • "DELETE"
          • "DEPRECATE"
          • "DISABLE"
        • includeResources — (map)

          Specifies the resources that the lifecycle policy applies to.

          • amis — (Boolean)

            Specifies whether the lifecycle action should apply to distributed AMIs.

          • snapshots — (Boolean)

            Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs.

          • containers — (Boolean)

            Specifies whether the lifecycle action should apply to distributed containers.

      • filterrequired — (map)

        Specifies the resources that the lifecycle policy applies to.

        • typerequired — (String)

          Filter resources based on either age or count.

          Possible values include:
          • "AGE"
          • "COUNT"
        • valuerequired — (Integer)

          The number of units for the time period or for the count. For example, a value of 6 might refer to six months or six AMIs.

          Note: For count-based filters, this value represents the minimum number of resources to keep on hand. If you have fewer resources than this number, the resource is excluded from lifecycle actions.
        • unit — (String)

          Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules.

          Possible values include:
          • "DAYS"
          • "WEEKS"
          • "MONTHS"
          • "YEARS"
        • retainAtLeast — (Integer)

          For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted.

      • exclusionRules — (map)

        Additional rules to specify resources that should be exempt from policy actions.

        • tagMap — (map<String>)

          Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them.

        • amis — (map)

          Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action.

          • isPublic — (Boolean)

            Configures whether public AMIs are excluded from the lifecycle action.

          • regions — (Array<String>)

            Configures Amazon Web Services Regions that are excluded from the lifecycle action.

          • sharedAccounts — (Array<String>)

            Specifies Amazon Web Services accounts whose resources are excluded from the lifecycle action.

          • lastLaunched — (map)

            Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions.

            • valuerequired — (Integer)

              The integer number of units for the time period. For example 6 (months).

            • unitrequired — (String)

              Defines the unit of time that the lifecycle policy uses to calculate elapsed time since the last instance launched from the AMI. For example: days, weeks, months, or years.

              Possible values include:
              • "DAYS"
              • "WEEKS"
              • "MONTHS"
              • "YEARS"
          • tagMap — (map<String>)

            Lists tags that should be excluded from lifecycle actions for the AMIs that have them.

    • resourceSelection — (map)

      Selection criteria for resources that the lifecycle policy applies to.

      • recipes — (Array<map>)

        A list of recipes that are used as selection criteria for the output images that the lifecycle policy applies to.

        • namerequired — (String)

          The name of an Image Builder recipe that the lifecycle policy uses for resource selection.

        • semanticVersionrequired — (String)

          The version of the Image Builder recipe specified by the name field.

      • tagMap — (map<String>)

        A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to.

    • clientToken — (String)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • lifecyclePolicyArn — (String)

        The ARN of the image lifecycle policy resource that was updated.

Returns:

  • (AWS.Request)

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