Class: AWS.Imagebuilder

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.

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 2³⁰-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.

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 2³⁰-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.

    • componentArn — required — (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.

      • name — required — (String)

        The name of the component parameter to set.

      • value — required — (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.

    • service — required — (String)

      Specifies the service in which this image was registered.

      Possible values include:
      • "ECR"
    • repositoryName — required — (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.

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.

    • region — required — (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.

      • targetRepository — required — (map)

        The destination repository for the container distribution configuration.

        • service — required — (String)

          Specifies the service in which this image was registered.

          Possible values include:
          • "ECR"
        • repositoryName — required — (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.

      • launchTemplateId — required — (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.

      • roleName — required — (String)

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

      • diskImageFormat — required — (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"
      • s3Bucket — required — (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.

      • enabled — required — (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.

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.

    • workflowArn — required — (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.

      • name — required — (String)

        The name of the workflow parameter to set.

      • value — required — (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.

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.

    • workflowArn — required — (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.

      • name — required — (String)

        The name of the workflow parameter to set.

      • value — required — (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.

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 2³⁰-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.

    • componentArn — required — (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.

      • name — required — (String)

        The name of the component parameter to set.

      • value — required — (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.

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.

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.

    • action — required — (map)

      Configuration details for the policy action.

      • type — required — (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.

    • filter — required — (map)

      Specifies the resources that the lifecycle policy applies to.

      • type — required — (String)

        Filter resources based on either age or count.

        Possible values include:
        • "AGE"
        • "COUNT"
      • value — required — (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.

          • value — required — (Integer)

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

          • unit — required — (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.

      • name — required — (String)

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

      • semanticVersion — required — (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.

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 2³⁰-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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

        • name — required — (String)

          The name of this input parameter.

        • type — required — (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.

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.

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 2³⁰-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.

        • componentArn — required — (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.

          • name — required — (String)

            The name of the component parameter to set.

          • value — required — (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.

        • service — required — (String)

          Specifies the service in which this image was registered.

          Possible values include:
          • "ECR"
        • repositoryName — required — (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.

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.

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.

        • region — required — (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.

          • targetRepository — required — (map)

            The destination repository for the container distribution configuration.

            • service — required — (String)

              Specifies the service in which this image was registered.

              Possible values include:
              • "ECR"
            • repositoryName — required — (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.

          • launchTemplateId — required — (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.

          • roleName — required — (String)

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

          • diskImageFormat — required — (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"
          • s3Bucket — required — (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.

          • enabled — required — (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.

      • timeoutMinutes — required — (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.

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 2³⁰-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.

          • componentArn — required — (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.

            • name — required — (String)

              The name of the component parameter to set.

            • value — required — (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 2³⁰-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.

          • componentArn — required — (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.

            • name — required — (String)

              The name of the component parameter to set.

            • value — required — (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.

          • service — required — (String)

            Specifies the service in which this image was registered.

            Possible values include:
            • "ECR"
          • repositoryName — required — (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.

          • region — required — (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.

            • targetRepository — required — (map)

              The destination repository for the container distribution configuration.

              • service — required — (String)

                Specifies the service in which this image was registered.

                Possible values include:
                • "ECR"
              • repositoryName — required — (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.

            • launchTemplateId — required — (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.

            • roleName — required — (String)

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

            • diskImageFormat — required — (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"
            • s3Bucket — required — (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.

            • enabled — required — (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.

        • timeoutMinutes — required — (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.

        • workflowArn — required — (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.

          • name — required — (String)

            The name of the workflow parameter to set.

          • value — required — (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.

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.

        • workflowArn — required — (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.

          • name — required — (String)

            The name of the workflow parameter to set.

          • value — required — (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.

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.

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.

        • componentArn — required — (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.

          • name — required — (String)

            The name of the component parameter to set.

          • value — required — (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.

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.

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.

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.

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.

        • action — required — (map)

          Configuration details for the policy action.

          • type — required — (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.

        • filter — required — (map)

          Specifies the resources that the lifecycle policy applies to.

          • type — required — (String)

            Filter resources based on either age or count.

            Possible values include:
            • "AGE"
            • "COUNT"
          • value — required — (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.

              • value — required — (Integer)

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

              • unit — required — (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.

          • name — required — (String)

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

          • semanticVersion — required — (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.

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.