AWS SDK for PHP 3.x

Client: Aws\imagebuilder\imagebuilderClient

Service ID: imagebuilder

Version: 2019-12-02

This page describes the parameters and results for the operations of the EC2 Image Builder (2019-12-02), and shows how to use the Aws\imagebuilder\imagebuilderClient object to call the described operations. This documentation is specific to the 2019-12-02 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelImageCreation ( array $params = [] )
CancelImageCreation cancels the creation of Image.
CreateComponent ( array $params = [] )
Creates a new component that can be used to build, validate, test, and assess your image.
CreateContainerRecipe ( array $params = [] )
Creates a new container recipe.
CreateDistributionConfiguration ( array $params = [] )
Creates a new distribution configuration.
CreateImage ( array $params = [] )
Creates a new image.
CreateImagePipeline ( array $params = [] )
Creates a new image pipeline.
CreateImageRecipe ( array $params = [] )
Creates a new image recipe.
CreateInfrastructureConfiguration ( array $params = [] )
Creates a new infrastructure configuration.
DeleteComponent ( array $params = [] )
Deletes a component build version.
DeleteContainerRecipe ( array $params = [] )
Deletes a container recipe.
DeleteDistributionConfiguration ( array $params = [] )
Deletes a distribution configuration.
DeleteImage ( array $params = [] )
Deletes an Image Builder image resource.
DeleteImagePipeline ( array $params = [] )
Deletes an image pipeline.
DeleteImageRecipe ( array $params = [] )
Deletes an image recipe.
DeleteInfrastructureConfiguration ( array $params = [] )
Deletes an infrastructure configuration.
GetComponent ( array $params = [] )
Gets a component object.
GetComponentPolicy ( array $params = [] )
Gets a component policy.
GetContainerRecipe ( array $params = [] )
Retrieves a container recipe.
GetContainerRecipePolicy ( array $params = [] )
Retrieves the policy for a container recipe.
GetDistributionConfiguration ( array $params = [] )
Gets a distribution configuration.
GetImage ( array $params = [] )
Gets an image.
GetImagePipeline ( array $params = [] )
Gets an image pipeline.
GetImagePolicy ( array $params = [] )
Gets an image policy.
GetImageRecipe ( array $params = [] )
Gets an image recipe.
GetImageRecipePolicy ( array $params = [] )
Gets an image recipe policy.
GetInfrastructureConfiguration ( array $params = [] )
Gets an infrastructure configuration.
GetWorkflowExecution ( array $params = [] )
Get the runtime information that was logged for a specific runtime instance of the workflow.
GetWorkflowStepExecution ( array $params = [] )
Get the runtime information that was logged for a specific runtime instance of the workflow step.
ImportComponent ( array $params = [] )
Imports a component and transforms its data into a component document.
ImportVmImage ( array $params = [] )
When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data.
ListComponentBuildVersions ( array $params = [] )
Returns the list of component build versions for the specified semantic version.
ListComponents ( array $params = [] )
Returns the list of components that can be filtered by name, or by using the listed filters to streamline results.
ListContainerRecipes ( array $params = [] )
Returns a list of container recipes.
ListDistributionConfigurations ( array $params = [] )
Returns a list of distribution configurations.
ListImageBuildVersions ( array $params = [] )
Returns a list of image build versions.
ListImagePackages ( array $params = [] )
List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.
ListImagePipelineImages ( array $params = [] )
Returns a list of images created by the specified pipeline.
ListImagePipelines ( array $params = [] )
Returns a list of image pipelines.
ListImageRecipes ( array $params = [] )
Returns a list of image recipes.
ListImageScanFindingAggregations ( array $params = [] )
Returns a list of image scan aggregations for your account.
ListImageScanFindings ( array $params = [] )
Returns a list of image scan findings for your account.
ListImages ( array $params = [] )
Returns the list of images that you have access to.
ListInfrastructureConfigurations ( array $params = [] )
Returns a list of infrastructure configurations.
ListTagsForResource ( array $params = [] )
Returns the list of tags for the specified resource.
ListWorkflowExecutions ( array $params = [] )
Returns a list of workflow runtime instance metadata objects for a specific image build version.
ListWorkflowStepExecutions ( array $params = [] )
Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.
PutComponentPolicy ( array $params = [] )
Applies a policy to a component.
PutContainerRecipePolicy ( array $params = [] )
Applies a policy to a container image.
PutImagePolicy ( array $params = [] )
Applies a policy to an image.
PutImageRecipePolicy ( array $params = [] )
Applies a policy to an image recipe.
StartImagePipelineExecution ( array $params = [] )
Manually triggers a pipeline to create an image.
TagResource ( array $params = [] )
Adds a tag to a resource.
UntagResource ( array $params = [] )
Removes a tag from a resource.
UpdateDistributionConfiguration ( array $params = [] )
Updates a new distribution configuration.
UpdateImagePipeline ( array $params = [] )
Updates an image pipeline.
UpdateInfrastructureConfiguration ( array $params = [] )
Updates a new infrastructure configuration.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListComponentBuildVersions
ListComponents
ListContainerRecipes
ListDistributionConfigurations
ListImageBuildVersions
ListImagePackages
ListImagePipelineImages
ListImagePipelines
ListImageRecipes
ListImageScanFindingAggregations
ListImageScanFindings
ListImages
ListInfrastructureConfigurations
ListWorkflowExecutions
ListWorkflowStepExecutions

Operations

CancelImageCreation

$result = $client->cancelImageCreation([/* ... */]);
$promise = $client->cancelImageCreationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->cancelImageCreation([
    'clientToken' => '<string>', // REQUIRED
    'imageBuildVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

Required: Yes
Type: 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.

imageBuildVersionArn

Required: Yes
Type: string

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

Result Syntax

[
    'clientToken' => '<string>',
    'imageBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token that was used for this request.

imageBuildVersionArn

Type: string

The ARN of the image whose creation this request canceled.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.

CreateComponent

$result = $client->createComponent([/* ... */]);
$promise = $client->createComponentAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createComponent([
    'changeDescription' => '<string>',
    'clientToken' => '<string>', // REQUIRED
    'data' => '<string>',
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'platform' => 'Windows|Linux', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'supportedOsVersions' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'uri' => '<string>',
]);

Parameter Details

Members

changeDescription

Type: 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 this component.

clientToken

Required: Yes
Type: string

The idempotency token of the component.

data

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

description

Type: string

Describes the contents of the component.

kmsKeyId

Type: string

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

name

Required: Yes
Type: string

The name of the component.

platform

Required: Yes
Type: string

The operating system platform of the component.

semanticVersion

Required: Yes
Type: string

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

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

supportedOsVersions

Type: Array of strings

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags that apply to the component.

uri

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

Result Syntax

[
    'clientToken' => '<string>',
    'componentBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

componentBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
InvalidVersionNumberException:
Your version number is out of bounds or does not follow the required syntax.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
InvalidParameterCombinationException:
You have specified two or more mutually exclusive parameters. Review the error message for details.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateContainerRecipe

$result = $client->createContainerRecipe([/* ... */]);
$promise = $client->createContainerRecipeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createContainerRecipe([
    'clientToken' => '<string>', // REQUIRED
    'components' => [ // REQUIRED
        [
            'componentArn' => '<string>', // REQUIRED
            'parameters' => [
                [
                    'name' => '<string>', // REQUIRED
                    'value' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'containerType' => 'DOCKER', // REQUIRED
    'description' => '<string>',
    'dockerfileTemplateData' => '<string>',
    'dockerfileTemplateUri' => '<string>',
    'imageOsVersionOverride' => '<string>',
    'instanceConfiguration' => [
        'blockDeviceMappings' => [
            [
                'deviceName' => '<string>',
                'ebs' => [
                    'deleteOnTermination' => true || false,
                    'encrypted' => true || false,
                    'iops' => <integer>,
                    'kmsKeyId' => '<string>',
                    'snapshotId' => '<string>',
                    'throughput' => <integer>,
                    'volumeSize' => <integer>,
                    'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                ],
                'noDevice' => '<string>',
                'virtualName' => '<string>',
            ],
            // ...
        ],
        'image' => '<string>',
    ],
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'parentImage' => '<string>', // REQUIRED
    'platformOverride' => 'Windows|Linux',
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetRepository' => [ // REQUIRED
        'repositoryName' => '<string>', // REQUIRED
        'service' => 'ECR', // REQUIRED
    ],
    'workingDirectory' => '<string>',
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The client token used to make this request idempotent.

components

Required: Yes
Type: Array of ComponentConfiguration structures

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.

containerType

Required: Yes
Type: string

The type of container to create.

description

Type: string

The description of the container recipe.

dockerfileTemplateData

Type: string

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

dockerfileTemplateUri

Type: string

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

imageOsVersionOverride

Type: string

Specifies the operating system version for the base image.

instanceConfiguration

Type: InstanceConfiguration structure

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

kmsKeyId

Type: string

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

name

Required: Yes
Type: string

The name of the container recipe.

parentImage

Required: Yes
Type: string

The base image for the container recipe.

platformOverride

Type: string

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

semanticVersion

Required: Yes
Type: string

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

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags that are attached to the container recipe.

targetRepository

Required: Yes
Type: TargetContainerRepository structure

The destination repository for the container image.

workingDirectory

Type: string

The working directory for use during build and test workflows.

Result Syntax

[
    'clientToken' => '<string>',
    'containerRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The client token used to make this request idempotent.

containerRecipeArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
InvalidVersionNumberException:
Your version number is out of bounds or does not follow the required syntax.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ResourceAlreadyExistsException:
The resource that you are trying to create already exists.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateDistributionConfiguration

$result = $client->createDistributionConfiguration([/* ... */]);
$promise = $client->createDistributionConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createDistributionConfiguration([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'distributions' => [ // REQUIRED
        [
            'amiDistributionConfiguration' => [
                'amiTags' => ['<string>', ...],
                'description' => '<string>',
                'kmsKeyId' => '<string>',
                'launchPermission' => [
                    'organizationArns' => ['<string>', ...],
                    'organizationalUnitArns' => ['<string>', ...],
                    'userGroups' => ['<string>', ...],
                    'userIds' => ['<string>', ...],
                ],
                'name' => '<string>',
                'targetAccountIds' => ['<string>', ...],
            ],
            'containerDistributionConfiguration' => [
                'containerTags' => ['<string>', ...],
                'description' => '<string>',
                'targetRepository' => [ // REQUIRED
                    'repositoryName' => '<string>', // REQUIRED
                    'service' => 'ECR', // REQUIRED
                ],
            ],
            'fastLaunchConfigurations' => [
                [
                    'accountId' => '<string>',
                    'enabled' => true || false, // REQUIRED
                    'launchTemplate' => [
                        'launchTemplateId' => '<string>',
                        'launchTemplateName' => '<string>',
                        'launchTemplateVersion' => '<string>',
                    ],
                    'maxParallelLaunches' => <integer>,
                    'snapshotConfiguration' => [
                        'targetResourceCount' => <integer>,
                    ],
                ],
                // ...
            ],
            'launchTemplateConfigurations' => [
                [
                    'accountId' => '<string>',
                    'launchTemplateId' => '<string>', // REQUIRED
                    'setDefaultVersion' => true || false,
                ],
                // ...
            ],
            'licenseConfigurationArns' => ['<string>', ...],
            'region' => '<string>', // REQUIRED
            's3ExportConfiguration' => [
                'diskImageFormat' => 'VMDK|RAW|VHD', // REQUIRED
                'roleName' => '<string>', // REQUIRED
                's3Bucket' => '<string>', // REQUIRED
                's3Prefix' => '<string>',
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token of the distribution configuration.

description

Type: string

The description of the distribution configuration.

distributions

Required: Yes
Type: Array of Distribution structures

The distributions of the distribution configuration.

name

Required: Yes
Type: string

The name of the distribution configuration.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the distribution configuration.

Result Syntax

[
    'clientToken' => '<string>',
    'distributionConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

distributionConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ResourceAlreadyExistsException:
The resource that you are trying to create already exists.
InvalidParameterCombinationException:
You have specified two or more mutually exclusive parameters. Review the error message for details.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateImage

$result = $client->createImage([/* ... */]);
$promise = $client->createImageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createImage([
    'clientToken' => '<string>', // REQUIRED
    'containerRecipeArn' => '<string>',
    'distributionConfigurationArn' => '<string>',
    'enhancedImageMetadataEnabled' => true || false,
    'imageRecipeArn' => '<string>',
    'imageScanningConfiguration' => [
        'ecrConfiguration' => [
            'containerTags' => ['<string>', ...],
            'repositoryName' => '<string>',
        ],
        'imageScanningEnabled' => true || false,
    ],
    'imageTestsConfiguration' => [
        'imageTestsEnabled' => true || false,
        'timeoutMinutes' => <integer>,
    ],
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

containerRecipeArn

Type: string

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

distributionConfigurationArn

Type: string

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

enhancedImageMetadataEnabled

Type: 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

Type: string

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

imageScanningConfiguration

Type: ImageScanningConfiguration structure

Contains settings for vulnerability scans.

imageTestsConfiguration

Type: ImageTestsConfiguration structure

The image tests configuration of the image.

infrastructureConfigurationArn

Required: Yes
Type: string

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the image.

Result Syntax

[
    'clientToken' => '<string>',
    'imageBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

imageBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateImagePipeline

$result = $client->createImagePipeline([/* ... */]);
$promise = $client->createImagePipelineAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createImagePipeline([
    'clientToken' => '<string>', // REQUIRED
    'containerRecipeArn' => '<string>',
    'description' => '<string>',
    'distributionConfigurationArn' => '<string>',
    'enhancedImageMetadataEnabled' => true || false,
    'imageRecipeArn' => '<string>',
    'imageScanningConfiguration' => [
        'ecrConfiguration' => [
            'containerTags' => ['<string>', ...],
            'repositoryName' => '<string>',
        ],
        'imageScanningEnabled' => true || false,
    ],
    'imageTestsConfiguration' => [
        'imageTestsEnabled' => true || false,
        'timeoutMinutes' => <integer>,
    ],
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'schedule' => [
        'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
        'scheduleExpression' => '<string>',
        'timezone' => '<string>',
    ],
    'status' => 'DISABLED|ENABLED',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

containerRecipeArn

Type: string

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

description

Type: string

The description of the image pipeline.

distributionConfigurationArn

Type: string

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

enhancedImageMetadataEnabled

Type: boolean

imageRecipeArn

Type: string

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

imageScanningConfiguration

Type: ImageScanningConfiguration structure

Contains settings for vulnerability scans.

imageTestsConfiguration

Type: ImageTestsConfiguration structure

The image test configuration of the image pipeline.

infrastructureConfigurationArn

Required: Yes
Type: string

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

name

Required: Yes
Type: string

The name of the image pipeline.

schedule

Type: Schedule structure

The schedule of the image pipeline.

status

Type: string

The status of the image pipeline.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the image pipeline.

Result Syntax

[
    'clientToken' => '<string>',
    'imagePipelineArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

imagePipelineArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ResourceAlreadyExistsException:
The resource that you are trying to create already exists.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateImageRecipe

$result = $client->createImageRecipe([/* ... */]);
$promise = $client->createImageRecipeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createImageRecipe([
    'additionalInstanceConfiguration' => [
        'systemsManagerAgent' => [
            'uninstallAfterBuild' => true || false,
        ],
        'userDataOverride' => '<string>',
    ],
    'blockDeviceMappings' => [
        [
            'deviceName' => '<string>',
            'ebs' => [
                'deleteOnTermination' => true || false,
                'encrypted' => true || false,
                'iops' => <integer>,
                'kmsKeyId' => '<string>',
                'snapshotId' => '<string>',
                'throughput' => <integer>,
                'volumeSize' => <integer>,
                'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
            ],
            'noDevice' => '<string>',
            'virtualName' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>', // REQUIRED
    'components' => [ // REQUIRED
        [
            'componentArn' => '<string>', // REQUIRED
            'parameters' => [
                [
                    'name' => '<string>', // REQUIRED
                    'value' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'parentImage' => '<string>', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workingDirectory' => '<string>',
]);

Parameter Details

Members

additionalInstanceConfiguration

Type: AdditionalInstanceConfiguration structure

Specify additional settings and launch scripts for your build instances.

blockDeviceMappings

Type: Array of InstanceBlockDeviceMapping structures

The block device mappings of the image recipe.

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

components

Required: Yes
Type: Array of ComponentConfiguration structures

The components included in the image recipe.

description

Type: string

The description of the image recipe.

name

Required: Yes
Type: string

The name of the image recipe.

parentImage

Required: Yes
Type: 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.

semanticVersion

Required: Yes
Type: string

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

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the image recipe.

workingDirectory

Type: string

The working directory used during build and test workflows.

Result Syntax

[
    'clientToken' => '<string>',
    'imageRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

imageRecipeArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
InvalidVersionNumberException:
Your version number is out of bounds or does not follow the required syntax.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ResourceAlreadyExistsException:
The resource that you are trying to create already exists.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

CreateInfrastructureConfiguration

$result = $client->createInfrastructureConfiguration([/* ... */]);
$promise = $client->createInfrastructureConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createInfrastructureConfiguration([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'instanceMetadataOptions' => [
        'httpPutResponseHopLimit' => <integer>,
        'httpTokens' => '<string>',
    ],
    'instanceProfileName' => '<string>', // REQUIRED
    'instanceTypes' => ['<string>', ...],
    'keyPair' => '<string>',
    'logging' => [
        's3Logs' => [
            's3BucketName' => '<string>',
            's3KeyPrefix' => '<string>',
        ],
    ],
    'name' => '<string>', // REQUIRED
    'resourceTags' => ['<string>', ...],
    'securityGroupIds' => ['<string>', ...],
    'snsTopicArn' => '<string>',
    'subnetId' => '<string>',
    'tags' => ['<string>', ...],
    'terminateInstanceOnFailure' => true || false,
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

description

Type: string

The description of the infrastructure configuration.

instanceMetadataOptions

Type: InstanceMetadataOptions structure

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

instanceProfileName

Required: Yes
Type: string

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

instanceTypes

Type: Array of strings

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.

keyPair

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

logging

Type: Logging structure

The logging configuration of the infrastructure configuration.

name

Required: Yes
Type: string

The name of the infrastructure configuration.

resourceTags

Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the resource created by Image Builder.

securityGroupIds

Type: Array of strings

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

snsTopicArn

Type: string

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

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.

subnetId

Type: string

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the infrastructure configuration.

terminateInstanceOnFailure

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

Result Syntax

[
    'clientToken' => '<string>',
    'infrastructureConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

infrastructureConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
ResourceAlreadyExistsException:
The resource that you are trying to create already exists.
ServiceQuotaExceededException:
You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

DeleteComponent

$result = $client->deleteComponent([/* ... */]);
$promise = $client->deleteComponentAsync([/* ... */]);

Deletes a component build version.

Parameter Syntax

$result = $client->deleteComponent([
    'componentBuildVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentBuildVersionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the component build version to delete.

Result Syntax

[
    'componentBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

componentBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteContainerRecipe

$result = $client->deleteContainerRecipe([/* ... */]);
$promise = $client->deleteContainerRecipeAsync([/* ... */]);

Deletes a container recipe.

Parameter Syntax

$result = $client->deleteContainerRecipe([
    'containerRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

containerRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'containerRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

containerRecipeArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteDistributionConfiguration

$result = $client->deleteDistributionConfiguration([/* ... */]);
$promise = $client->deleteDistributionConfigurationAsync([/* ... */]);

Deletes a distribution configuration.

Parameter Syntax

$result = $client->deleteDistributionConfiguration([
    'distributionConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

distributionConfigurationArn

Required: Yes
Type: string

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

Result Syntax

[
    'distributionConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

distributionConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ServiceUnavailableException:
The service is unable to process your request at this time.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteImage

$result = $client->deleteImage([/* ... */]);
$promise = $client->deleteImageAsync([/* ... */]);

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

To deregister an EC2 Linux AMI, see Deregister your Linux AMI in the Amazon EC2 User Guide .
To deregister an EC2 Windows AMI, see Deregister your Windows AMI in the Amazon EC2 Windows Guide .
To delete a container image from Amazon ECR, see Deleting an image in the Amazon ECR User Guide.

Parameter Syntax

$result = $client->deleteImage([
    'imageBuildVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageBuildVersionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Image Builder image resource to delete.

Result Syntax

[
    'imageBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ServiceUnavailableException:
The service is unable to process your request at this time.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteImagePipeline

$result = $client->deleteImagePipeline([/* ... */]);
$promise = $client->deleteImagePipelineAsync([/* ... */]);

Deletes an image pipeline.

Parameter Syntax

$result = $client->deleteImagePipeline([
    'imagePipelineArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imagePipelineArn

Required: Yes
Type: string

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

Result Syntax

[
    'imagePipelineArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imagePipelineArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteImageRecipe

$result = $client->deleteImageRecipe([/* ... */]);
$promise = $client->deleteImageRecipeAsync([/* ... */]);

Deletes an image recipe.

Parameter Syntax

$result = $client->deleteImageRecipe([
    'imageRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'imageRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageRecipeArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

DeleteInfrastructureConfiguration

$result = $client->deleteInfrastructureConfiguration([/* ... */]);
$promise = $client->deleteInfrastructureConfigurationAsync([/* ... */]);

Deletes an infrastructure configuration.

Parameter Syntax

$result = $client->deleteInfrastructureConfiguration([
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

infrastructureConfigurationArn

Required: Yes
Type: string

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

Result Syntax

[
    'infrastructureConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

infrastructureConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceDependencyException:
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.

GetComponent

$result = $client->getComponent([/* ... */]);
$promise = $client->getComponentAsync([/* ... */]);

Gets a component object.

Parameter Syntax

$result = $client->getComponent([
    'componentBuildVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentBuildVersionArn

Required: Yes
Type: string

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

Result Syntax

[
    'component' => [
        'arn' => '<string>',
        'changeDescription' => '<string>',
        'data' => '<string>',
        'dateCreated' => '<string>',
        'description' => '<string>',
        'encrypted' => true || false,
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'obfuscate' => true || false,
        'owner' => '<string>',
        'parameters' => [
            [
                'defaultValue' => ['<string>', ...],
                'description' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'platform' => 'Windows|Linux',
        'publisher' => '<string>',
        'state' => [
            'reason' => '<string>',
            'status' => 'DEPRECATED',
        ],
        'supportedOsVersions' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'type' => 'BUILD|TEST',
        'version' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

Members

component

Type: Component structure

The component object associated with the specified ARN.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetComponentPolicy

$result = $client->getComponentPolicy([/* ... */]);
$promise = $client->getComponentPolicyAsync([/* ... */]);

Gets a component policy.

Parameter Syntax

$result = $client->getComponentPolicy([
    'componentArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.

Result Syntax

[
    'policy' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

policy

Type: string

The component policy.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ServiceUnavailableException:
The service is unable to process your request at this time.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetContainerRecipe

$result = $client->getContainerRecipe([/* ... */]);
$promise = $client->getContainerRecipeAsync([/* ... */]);

Retrieves a container recipe.

Parameter Syntax

$result = $client->getContainerRecipe([
    'containerRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

containerRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'containerRecipe' => [
        'arn' => '<string>',
        'components' => [
            [
                'componentArn' => '<string>',
                'parameters' => [
                    [
                        'name' => '<string>',
                        'value' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'containerType' => 'DOCKER',
        'dateCreated' => '<string>',
        'description' => '<string>',
        'dockerfileTemplateData' => '<string>',
        'encrypted' => true || false,
        'instanceConfiguration' => [
            'blockDeviceMappings' => [
                [
                    'deviceName' => '<string>',
                    'ebs' => [
                        'deleteOnTermination' => true || false,
                        'encrypted' => true || false,
                        'iops' => <integer>,
                        'kmsKeyId' => '<string>',
                        'snapshotId' => '<string>',
                        'throughput' => <integer>,
                        'volumeSize' => <integer>,
                        'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                    ],
                    'noDevice' => '<string>',
                    'virtualName' => '<string>',
                ],
                // ...
            ],
            'image' => '<string>',
        ],
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'parentImage' => '<string>',
        'platform' => 'Windows|Linux',
        'tags' => ['<string>', ...],
        'targetRepository' => [
            'repositoryName' => '<string>',
            'service' => 'ECR',
        ],
        'version' => '<string>',
        'workingDirectory' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

Members

containerRecipe

Type: ContainerRecipe structure

The container recipe object that is returned.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetContainerRecipePolicy

$result = $client->getContainerRecipePolicy([/* ... */]);
$promise = $client->getContainerRecipePolicyAsync([/* ... */]);

Retrieves the policy for a container recipe.

Parameter Syntax

$result = $client->getContainerRecipePolicy([
    'containerRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

containerRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'policy' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

policy

Type: string

The container recipe policy object that is returned.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetDistributionConfiguration

$result = $client->getDistributionConfiguration([/* ... */]);
$promise = $client->getDistributionConfigurationAsync([/* ... */]);

Gets a distribution configuration.

Parameter Syntax

$result = $client->getDistributionConfiguration([
    'distributionConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

distributionConfigurationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the distribution configuration that you want to retrieve.

Result Syntax

[
    'distributionConfiguration' => [
        'arn' => '<string>',
        'dateCreated' => '<string>',
        'dateUpdated' => '<string>',
        'description' => '<string>',
        'distributions' => [
            [
                'amiDistributionConfiguration' => [
                    'amiTags' => ['<string>', ...],
                    'description' => '<string>',
                    'kmsKeyId' => '<string>',
                    'launchPermission' => [
                        'organizationArns' => ['<string>', ...],
                        'organizationalUnitArns' => ['<string>', ...],
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'name' => '<string>',
                    'targetAccountIds' => ['<string>', ...],
                ],
                'containerDistributionConfiguration' => [
                    'containerTags' => ['<string>', ...],
                    'description' => '<string>',
                    'targetRepository' => [
                        'repositoryName' => '<string>',
                        'service' => 'ECR',
                    ],
                ],
                'fastLaunchConfigurations' => [
                    [
                        'accountId' => '<string>',
                        'enabled' => true || false,
                        'launchTemplate' => [
                            'launchTemplateId' => '<string>',
                            'launchTemplateName' => '<string>',
                            'launchTemplateVersion' => '<string>',
                        ],
                        'maxParallelLaunches' => <integer>,
                        'snapshotConfiguration' => [
                            'targetResourceCount' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'launchTemplateConfigurations' => [
                    [
                        'accountId' => '<string>',
                        'launchTemplateId' => '<string>',
                        'setDefaultVersion' => true || false,
                    ],
                    // ...
                ],
                'licenseConfigurationArns' => ['<string>', ...],
                'region' => '<string>',
                's3ExportConfiguration' => [
                    'diskImageFormat' => 'VMDK|RAW|VHD',
                    'roleName' => '<string>',
                    's3Bucket' => '<string>',
                    's3Prefix' => '<string>',
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'timeoutMinutes' => <integer>,
    ],
    'requestId' => '<string>',
]

Result Details

Members

distributionConfiguration

Type: DistributionConfiguration structure

The distribution configuration object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetImage

$result = $client->getImage([/* ... */]);
$promise = $client->getImageAsync([/* ... */]);

Gets an image.

Parameter Syntax

$result = $client->getImage([
    'imageBuildVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageBuildVersionArn

Required: Yes
Type: string

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

Result Syntax

[
    'image' => [
        'arn' => '<string>',
        'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT',
        'containerRecipe' => [
            'arn' => '<string>',
            'components' => [
                [
                    'componentArn' => '<string>',
                    'parameters' => [
                        [
                            'name' => '<string>',
                            'value' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'containerType' => 'DOCKER',
            'dateCreated' => '<string>',
            'description' => '<string>',
            'dockerfileTemplateData' => '<string>',
            'encrypted' => true || false,
            'instanceConfiguration' => [
                'blockDeviceMappings' => [
                    [
                        'deviceName' => '<string>',
                        'ebs' => [
                            'deleteOnTermination' => true || false,
                            'encrypted' => true || false,
                            'iops' => <integer>,
                            'kmsKeyId' => '<string>',
                            'snapshotId' => '<string>',
                            'throughput' => <integer>,
                            'volumeSize' => <integer>,
                            'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                        ],
                        'noDevice' => '<string>',
                        'virtualName' => '<string>',
                    ],
                    // ...
                ],
                'image' => '<string>',
            ],
            'kmsKeyId' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
            'targetRepository' => [
                'repositoryName' => '<string>',
                'service' => 'ECR',
            ],
            'version' => '<string>',
            'workingDirectory' => '<string>',
        ],
        'dateCreated' => '<string>',
        'distributionConfiguration' => [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'distributions' => [
                [
                    'amiDistributionConfiguration' => [
                        'amiTags' => ['<string>', ...],
                        'description' => '<string>',
                        'kmsKeyId' => '<string>',
                        'launchPermission' => [
                            'organizationArns' => ['<string>', ...],
                            'organizationalUnitArns' => ['<string>', ...],
                            'userGroups' => ['<string>', ...],
                            'userIds' => ['<string>', ...],
                        ],
                        'name' => '<string>',
                        'targetAccountIds' => ['<string>', ...],
                    ],
                    'containerDistributionConfiguration' => [
                        'containerTags' => ['<string>', ...],
                        'description' => '<string>',
                        'targetRepository' => [
                            'repositoryName' => '<string>',
                            'service' => 'ECR',
                        ],
                    ],
                    'fastLaunchConfigurations' => [
                        [
                            'accountId' => '<string>',
                            'enabled' => true || false,
                            'launchTemplate' => [
                                'launchTemplateId' => '<string>',
                                'launchTemplateName' => '<string>',
                                'launchTemplateVersion' => '<string>',
                            ],
                            'maxParallelLaunches' => <integer>,
                            'snapshotConfiguration' => [
                                'targetResourceCount' => <integer>,
                            ],
                        ],
                        // ...
                    ],
                    'launchTemplateConfigurations' => [
                        [
                            'accountId' => '<string>',
                            'launchTemplateId' => '<string>',
                            'setDefaultVersion' => true || false,
                        ],
                        // ...
                    ],
                    'licenseConfigurationArns' => ['<string>', ...],
                    'region' => '<string>',
                    's3ExportConfiguration' => [
                        'diskImageFormat' => 'VMDK|RAW|VHD',
                        'roleName' => '<string>',
                        's3Bucket' => '<string>',
                        's3Prefix' => '<string>',
                    ],
                ],
                // ...
            ],
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'timeoutMinutes' => <integer>,
        ],
        'enhancedImageMetadataEnabled' => true || false,
        'imageRecipe' => [
            'additionalInstanceConfiguration' => [
                'systemsManagerAgent' => [
                    'uninstallAfterBuild' => true || false,
                ],
                'userDataOverride' => '<string>',
            ],
            'arn' => '<string>',
            'blockDeviceMappings' => [
                [
                    'deviceName' => '<string>',
                    'ebs' => [
                        'deleteOnTermination' => true || false,
                        'encrypted' => true || false,
                        'iops' => <integer>,
                        'kmsKeyId' => '<string>',
                        'snapshotId' => '<string>',
                        'throughput' => <integer>,
                        'volumeSize' => <integer>,
                        'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                    ],
                    'noDevice' => '<string>',
                    'virtualName' => '<string>',
                ],
                // ...
            ],
            'components' => [
                [
                    'componentArn' => '<string>',
                    'parameters' => [
                        [
                            'name' => '<string>',
                            'value' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
            'workingDirectory' => '<string>',
        ],
        'imageScanningConfiguration' => [
            'ecrConfiguration' => [
                'containerTags' => ['<string>', ...],
                'repositoryName' => '<string>',
            ],
            'imageScanningEnabled' => true || false,
        ],
        'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
        'imageTestsConfiguration' => [
            'imageTestsEnabled' => true || false,
            'timeoutMinutes' => <integer>,
        ],
        'infrastructureConfiguration' => [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'instanceMetadataOptions' => [
                'httpPutResponseHopLimit' => <integer>,
                'httpTokens' => '<string>',
            ],
            'instanceProfileName' => '<string>',
            'instanceTypes' => ['<string>', ...],
            'keyPair' => '<string>',
            'logging' => [
                's3Logs' => [
                    's3BucketName' => '<string>',
                    's3KeyPrefix' => '<string>',
                ],
            ],
            'name' => '<string>',
            'resourceTags' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'snsTopicArn' => '<string>',
            'subnetId' => '<string>',
            'tags' => ['<string>', ...],
            'terminateInstanceOnFailure' => true || false,
        ],
        'name' => '<string>',
        'osVersion' => '<string>',
        'outputResources' => [
            'amis' => [
                [
                    'accountId' => '<string>',
                    'description' => '<string>',
                    'image' => '<string>',
                    'name' => '<string>',
                    'region' => '<string>',
                    'state' => [
                        'reason' => '<string>',
                        'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
                    ],
                ],
                // ...
            ],
            'containers' => [
                [
                    'imageUris' => ['<string>', ...],
                    'region' => '<string>',
                ],
                // ...
            ],
        ],
        'platform' => 'Windows|Linux',
        'scanState' => [
            'reason' => '<string>',
            'status' => 'PENDING|SCANNING|COLLECTING|COMPLETED|ABANDONED|FAILED|TIMED_OUT',
        ],
        'sourcePipelineArn' => '<string>',
        'sourcePipelineName' => '<string>',
        'state' => [
            'reason' => '<string>',
            'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
        ],
        'tags' => ['<string>', ...],
        'type' => 'AMI|DOCKER',
        'version' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

Members

image

Type: Image structure

The image object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetImagePipeline

$result = $client->getImagePipeline([/* ... */]);
$promise = $client->getImagePipelineAsync([/* ... */]);

Gets an image pipeline.

Parameter Syntax

$result = $client->getImagePipeline([
    'imagePipelineArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imagePipelineArn

Required: Yes
Type: string

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

Result Syntax

[
    'imagePipeline' => [
        'arn' => '<string>',
        'containerRecipeArn' => '<string>',
        'dateCreated' => '<string>',
        'dateLastRun' => '<string>',
        'dateNextRun' => '<string>',
        'dateUpdated' => '<string>',
        'description' => '<string>',
        'distributionConfigurationArn' => '<string>',
        'enhancedImageMetadataEnabled' => true || false,
        'imageRecipeArn' => '<string>',
        'imageScanningConfiguration' => [
            'ecrConfiguration' => [
                'containerTags' => ['<string>', ...],
                'repositoryName' => '<string>',
            ],
            'imageScanningEnabled' => true || false,
        ],
        'imageTestsConfiguration' => [
            'imageTestsEnabled' => true || false,
            'timeoutMinutes' => <integer>,
        ],
        'infrastructureConfigurationArn' => '<string>',
        'name' => '<string>',
        'platform' => 'Windows|Linux',
        'schedule' => [
            'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
            'scheduleExpression' => '<string>',
            'timezone' => '<string>',
        ],
        'status' => 'DISABLED|ENABLED',
        'tags' => ['<string>', ...],
    ],
    'requestId' => '<string>',
]

Result Details

Members

imagePipeline

Type: ImagePipeline structure

The image pipeline object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetImagePolicy

$result = $client->getImagePolicy([/* ... */]);
$promise = $client->getImagePolicyAsync([/* ... */]);

Gets an image policy.

Parameter Syntax

$result = $client->getImagePolicy([
    'imageArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageArn

Required: Yes
Type: string

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

Result Syntax

[
    'policy' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

policy

Type: string

The image policy object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ServiceUnavailableException:
The service is unable to process your request at this time.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetImageRecipe

$result = $client->getImageRecipe([/* ... */]);
$promise = $client->getImageRecipeAsync([/* ... */]);

Gets an image recipe.

Parameter Syntax

$result = $client->getImageRecipe([
    'imageRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'imageRecipe' => [
        'additionalInstanceConfiguration' => [
            'systemsManagerAgent' => [
                'uninstallAfterBuild' => true || false,
            ],
            'userDataOverride' => '<string>',
        ],
        'arn' => '<string>',
        'blockDeviceMappings' => [
            [
                'deviceName' => '<string>',
                'ebs' => [
                    'deleteOnTermination' => true || false,
                    'encrypted' => true || false,
                    'iops' => <integer>,
                    'kmsKeyId' => '<string>',
                    'snapshotId' => '<string>',
                    'throughput' => <integer>,
                    'volumeSize' => <integer>,
                    'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                ],
                'noDevice' => '<string>',
                'virtualName' => '<string>',
            ],
            // ...
        ],
        'components' => [
            [
                'componentArn' => '<string>',
                'parameters' => [
                    [
                        'name' => '<string>',
                        'value' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'dateCreated' => '<string>',
        'description' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'parentImage' => '<string>',
        'platform' => 'Windows|Linux',
        'tags' => ['<string>', ...],
        'type' => 'AMI|DOCKER',
        'version' => '<string>',
        'workingDirectory' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

Members

imageRecipe

Type: ImageRecipe structure

The image recipe object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetImageRecipePolicy

$result = $client->getImageRecipePolicy([/* ... */]);
$promise = $client->getImageRecipePolicyAsync([/* ... */]);

Gets an image recipe policy.

Parameter Syntax

$result = $client->getImageRecipePolicy([
    'imageRecipeArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageRecipeArn

Required: Yes
Type: string

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

Result Syntax

[
    'policy' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

policy

Type: string

The image recipe policy object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetInfrastructureConfiguration

$result = $client->getInfrastructureConfiguration([/* ... */]);
$promise = $client->getInfrastructureConfigurationAsync([/* ... */]);

Gets an infrastructure configuration.

Parameter Syntax

$result = $client->getInfrastructureConfiguration([
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

infrastructureConfigurationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to retrieve.

Result Syntax

[
    'infrastructureConfiguration' => [
        'arn' => '<string>',
        'dateCreated' => '<string>',
        'dateUpdated' => '<string>',
        'description' => '<string>',
        'instanceMetadataOptions' => [
            'httpPutResponseHopLimit' => <integer>,
            'httpTokens' => '<string>',
        ],
        'instanceProfileName' => '<string>',
        'instanceTypes' => ['<string>', ...],
        'keyPair' => '<string>',
        'logging' => [
            's3Logs' => [
                's3BucketName' => '<string>',
                's3KeyPrefix' => '<string>',
            ],
        ],
        'name' => '<string>',
        'resourceTags' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'snsTopicArn' => '<string>',
        'subnetId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateInstanceOnFailure' => true || false,
    ],
    'requestId' => '<string>',
]

Result Details

Members

infrastructureConfiguration

Type: InfrastructureConfiguration structure

The infrastructure configuration object.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetWorkflowExecution

$result = $client->getWorkflowExecution([/* ... */]);
$promise = $client->getWorkflowExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getWorkflowExecution([
    'workflowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

workflowExecutionId

Required: Yes
Type: string

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

Result Syntax

[
    'endTime' => '<string>',
    'imageBuildVersionArn' => '<string>',
    'message' => '<string>',
    'requestId' => '<string>',
    'startTime' => '<string>',
    'status' => 'PENDING|SKIPPED|RUNNING|COMPLETED|FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETED',
    'totalStepCount' => <integer>,
    'totalStepsFailed' => <integer>,
    'totalStepsSkipped' => <integer>,
    'totalStepsSucceeded' => <integer>,
    'type' => 'BUILD|TEST|DISTRIBUTION',
    'workflowBuildVersionArn' => '<string>',
    'workflowExecutionId' => '<string>',
]

Result Details

Members

endTime

Type: string

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

imageBuildVersionArn

Type: string

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

message

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

startTime

Type: string

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

status

Type: string

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

totalStepCount

Type: int

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

totalStepsFailed

Type: int

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

totalStepsSkipped

Type: int

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

totalStepsSucceeded

Type: int

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

type

Type: string

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

workflowBuildVersionArn

Type: string

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

workflowExecutionId

Type: string

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

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

GetWorkflowStepExecution

$result = $client->getWorkflowStepExecution([/* ... */]);
$promise = $client->getWorkflowStepExecutionAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getWorkflowStepExecution([
    'stepExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

stepExecutionId

Required: Yes
Type: string

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

Result Syntax

[
    'action' => '<string>',
    'description' => '<string>',
    'endTime' => '<string>',
    'imageBuildVersionArn' => '<string>',
    'inputs' => '<string>',
    'message' => '<string>',
    'name' => '<string>',
    'onFailure' => '<string>',
    'outputs' => '<string>',
    'requestId' => '<string>',
    'rollbackStatus' => 'RUNNING|COMPLETED|SKIPPED|FAILED',
    'startTime' => '<string>',
    'status' => 'PENDING|SKIPPED|RUNNING|COMPLETED|FAILED',
    'stepExecutionId' => '<string>',
    'timeoutSeconds' => <integer>,
    'workflowBuildVersionArn' => '<string>',
    'workflowExecutionId' => '<string>',
]

Result Details

Members

action

Type: string

The name of the action that the specified step performs.

description

Type: string

Describes the specified workflow step.

endTime

Type: string

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

imageBuildVersionArn

Type: string

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

inputs

Type: string

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

message

Type: string

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

name

Type: string

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

onFailure

Type: string

The action to perform if the workflow step fails.

outputs

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

rollbackStatus

Type: string

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

startTime

Type: string

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

status

Type: string

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

stepExecutionId

Type: string

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

timeoutSeconds

Type: int

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

workflowBuildVersionArn

Type: string

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

workflowExecutionId

Type: string

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

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ImportComponent

$result = $client->importComponent([/* ... */]);
$promise = $client->importComponentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->importComponent([
    'changeDescription' => '<string>',
    'clientToken' => '<string>', // REQUIRED
    'data' => '<string>',
    'description' => '<string>',
    'format' => 'SHELL', // REQUIRED
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'platform' => 'Windows|Linux', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'BUILD|TEST', // REQUIRED
    'uri' => '<string>',
]);

Parameter Details

Members

changeDescription

Type: string

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

clientToken

Required: Yes
Type: string

The idempotency token of the component.

data

Type: string

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

description

Type: string

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

format

Required: Yes
Type: string

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

kmsKeyId

Type: string

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

name

Required: Yes
Type: string

The name of the component.

platform

Required: Yes
Type: string

The platform of the component.

semanticVersion

Required: Yes
Type: string

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

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

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the component.

type

Required: Yes
Type: string

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

uri

Type: string

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

Result Syntax

[
    'clientToken' => '<string>',
    'componentBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

componentBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
InvalidVersionNumberException:
Your version number is out of bounds or does not follow the required syntax.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
InvalidParameterCombinationException:
You have specified two or more mutually exclusive parameters. Review the error message for details.

ImportVmImage

$result = $client->importVmImage([/* ... */]);
$promise = $client->importVmImageAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->importVmImage([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'osVersion' => '<string>',
    'platform' => 'Windows|Linux', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'vmImportTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

Required: Yes
Type: 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.

description

Type: string

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

name

Required: Yes
Type: string

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

osVersion

Type: string

The operating system version for the imported VM.

platform

Required: Yes
Type: string

The operating system platform for the imported VM.

semanticVersion

Required: Yes
Type: string

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

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags that are attached to the import resources.

vmImportTaskId

Required: Yes
Type: string

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

Result Syntax

[
    'clientToken' => '<string>',
    'imageArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token that was used for this request.

imageArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.

ListComponentBuildVersions

$result = $client->listComponentBuildVersions([/* ... */]);
$promise = $client->listComponentBuildVersionsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->listComponentBuildVersions([
    'componentVersionArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

componentVersionArn

Required: Yes
Type: string

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

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'componentSummaryList' => [
        [
            'arn' => '<string>',
            'changeDescription' => '<string>',
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'obfuscate' => true || false,
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'publisher' => '<string>',
            'state' => [
                'reason' => '<string>',
                'status' => 'DEPRECATED',
            ],
            'supportedOsVersions' => ['<string>', ...],
            'tags' => ['<string>', ...],
            'type' => 'BUILD|TEST',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

componentSummaryList

Type: Array of ComponentSummary structures

The list of component summaries for the specified semantic version.

nextToken

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

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

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.

Parameter Syntax

$result = $client->listComponents([
    'byName' => true || false,
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owner' => 'Self|Shared|Amazon|ThirdParty',
]);

Parameter Details

Members

byName

Type: boolean

Returns the list of components for the specified name.

filters

Type: Array of Filter structures

Use the following filters to streamline results:

description
name
platform
supportedOsVersion
type
version

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

owner

Type: string

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

Result Syntax

[
    'componentVersionList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'supportedOsVersions' => ['<string>', ...],
            'type' => 'BUILD|TEST',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

componentVersionList

Type: Array of ComponentVersion structures

The list of component semantic versions.

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.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListContainerRecipes

$result = $client->listContainerRecipes([/* ... */]);
$promise = $client->listContainerRecipesAsync([/* ... */]);

Returns a list of container recipes.

Parameter Syntax

$result = $client->listContainerRecipes([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owner' => 'Self|Shared|Amazon|ThirdParty',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

Use the following filters to streamline results:

containerType
name
parentImage
platform

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

owner

Type: string

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

Result Syntax

[
    'containerRecipeSummaryList' => [
        [
            'arn' => '<string>',
            'containerType' => 'DOCKER',
            'dateCreated' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

containerRecipeSummaryList

Type: Array of ContainerRecipeSummary structures

The list of container recipes returned for the request.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListDistributionConfigurations

$result = $client->listDistributionConfigurations([/* ... */]);
$promise = $client->listDistributionConfigurationsAsync([/* ... */]);

Returns a list of distribution configurations.

Parameter Syntax

$result = $client->listDistributionConfigurations([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

You can filter on name to streamline results.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'distributionConfigurationSummaryList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'regions' => ['<string>', ...],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

distributionConfigurationSummaryList

Type: Array of DistributionConfigurationSummary structures

The list of distributions.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImageBuildVersions

$result = $client->listImageBuildVersions([/* ... */]);
$promise = $client->listImageBuildVersionsAsync([/* ... */]);

Returns a list of image build versions.

Parameter Syntax

$result = $client->listImageBuildVersions([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'imageVersionArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

Use the following filters to streamline results:

name
osVersion
platform
type
version

imageVersionArn

Required: Yes
Type: string

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

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'imageSummaryList' => [
        [
            'arn' => '<string>',
            'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT',
            'dateCreated' => '<string>',
            'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
            'name' => '<string>',
            'osVersion' => '<string>',
            'outputResources' => [
                'amis' => [
                    [
                        'accountId' => '<string>',
                        'description' => '<string>',
                        'image' => '<string>',
                        'name' => '<string>',
                        'region' => '<string>',
                        'state' => [
                            'reason' => '<string>',
                            'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
                        ],
                    ],
                    // ...
                ],
                'containers' => [
                    [
                        'imageUris' => ['<string>', ...],
                        'region' => '<string>',
                    ],
                    // ...
                ],
            ],
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'state' => [
                'reason' => '<string>',
                'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageSummaryList

Type: Array of ImageSummary structures

The list of image build versions.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImagePackages

$result = $client->listImagePackages([/* ... */]);
$promise = $client->listImagePackagesAsync([/* ... */]);

List the Packages that are associated with an Image Build Version, as determined by Amazon Web Services Systems Manager Inventory at build time.

Parameter Syntax

$result = $client->listImagePackages([
    'imageBuildVersionArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

imageBuildVersionArn

Required: Yes
Type: string

Filter results for the ListImagePackages request by the Image Build Version ARN

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'imagePackageList' => [
        [
            'packageName' => '<string>',
            'packageVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imagePackageList

Type: Array of ImagePackage structures

The list of Image Packages returned in the response.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImagePipelineImages

$result = $client->listImagePipelineImages([/* ... */]);
$promise = $client->listImagePipelineImagesAsync([/* ... */]);

Returns a list of images created by the specified pipeline.

Parameter Syntax

$result = $client->listImagePipelineImages([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'imagePipelineArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

Use the following filters to streamline results:

name
version

imagePipelineArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the image pipeline whose images you want to view.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'imageSummaryList' => [
        [
            'arn' => '<string>',
            'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT',
            'dateCreated' => '<string>',
            'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
            'name' => '<string>',
            'osVersion' => '<string>',
            'outputResources' => [
                'amis' => [
                    [
                        'accountId' => '<string>',
                        'description' => '<string>',
                        'image' => '<string>',
                        'name' => '<string>',
                        'region' => '<string>',
                        'state' => [
                            'reason' => '<string>',
                            'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
                        ],
                    ],
                    // ...
                ],
                'containers' => [
                    [
                        'imageUris' => ['<string>', ...],
                        'region' => '<string>',
                    ],
                    // ...
                ],
            ],
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'state' => [
                'reason' => '<string>',
                'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageSummaryList

Type: Array of ImageSummary structures

The list of images built by this pipeline.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImagePipelines

$result = $client->listImagePipelines([/* ... */]);
$promise = $client->listImagePipelinesAsync([/* ... */]);

Returns a list of image pipelines.

Parameter Syntax

$result = $client->listImagePipelines([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

Use the following filters to streamline results:

description
distributionConfigurationArn
imageRecipeArn
infrastructureConfigurationArn
name
status

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'imagePipelineList' => [
        [
            'arn' => '<string>',
            'containerRecipeArn' => '<string>',
            'dateCreated' => '<string>',
            'dateLastRun' => '<string>',
            'dateNextRun' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'distributionConfigurationArn' => '<string>',
            'enhancedImageMetadataEnabled' => true || false,
            'imageRecipeArn' => '<string>',
            'imageScanningConfiguration' => [
                'ecrConfiguration' => [
                    'containerTags' => ['<string>', ...],
                    'repositoryName' => '<string>',
                ],
                'imageScanningEnabled' => true || false,
            ],
            'imageTestsConfiguration' => [
                'imageTestsEnabled' => true || false,
                'timeoutMinutes' => <integer>,
            ],
            'infrastructureConfigurationArn' => '<string>',
            'name' => '<string>',
            'platform' => 'Windows|Linux',
            'schedule' => [
                'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
                'scheduleExpression' => '<string>',
                'timezone' => '<string>',
            ],
            'status' => 'DISABLED|ENABLED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imagePipelineList

Type: Array of ImagePipeline structures

The list of image pipelines.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImageRecipes

$result = $client->listImageRecipes([/* ... */]);
$promise = $client->listImageRecipesAsync([/* ... */]);

Returns a list of image recipes.

Parameter Syntax

$result = $client->listImageRecipes([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owner' => 'Self|Shared|Amazon|ThirdParty',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

Use the following filters to streamline results:

name
parentImage
platform

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

owner

Type: string

The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

Result Syntax

[
    'imageRecipeSummaryList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageRecipeSummaryList

Type: Array of ImageRecipeSummary structures

The list of image pipelines.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImageScanFindingAggregations

$result = $client->listImageScanFindingAggregations([/* ... */]);
$promise = $client->listImageScanFindingAggregationsAsync([/* ... */]);

Returns a list of image scan aggregations for your account. You can filter by the type of key that Image Builder uses to group results. For example, if you want to get a list of findings by severity level for one of your pipelines, you might specify your pipeline with the imagePipelineArn filter. If you don't specify a filter, Image Builder returns an aggregation for your account.

To streamline results, you can use the following filters in your request:

accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId

Parameter Syntax

$result = $client->listImageScanFindingAggregations([
    'filter' => [
        'name' => '<string>',
        'values' => ['<string>', ...],
    ],
    'nextToken' => '<string>',
]);

Parameter Details

Members

filter

Type: Filter structure

A filter name and value pair that is used to return a more specific list of results from a list operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

nextToken

Type: string

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

Result Syntax

[
    'aggregationType' => '<string>',
    'nextToken' => '<string>',
    'requestId' => '<string>',
    'responses' => [
        [
            'accountAggregation' => [
                'accountId' => '<string>',
                'severityCounts' => [
                    'all' => <integer>,
                    'critical' => <integer>,
                    'high' => <integer>,
                    'medium' => <integer>,
                ],
            ],
            'imageAggregation' => [
                'imageBuildVersionArn' => '<string>',
                'severityCounts' => [
                    'all' => <integer>,
                    'critical' => <integer>,
                    'high' => <integer>,
                    'medium' => <integer>,
                ],
            ],
            'imagePipelineAggregation' => [
                'imagePipelineArn' => '<string>',
                'severityCounts' => [
                    'all' => <integer>,
                    'critical' => <integer>,
                    'high' => <integer>,
                    'medium' => <integer>,
                ],
            ],
            'vulnerabilityIdAggregation' => [
                'severityCounts' => [
                    'all' => <integer>,
                    'critical' => <integer>,
                    'high' => <integer>,
                    'medium' => <integer>,
                ],
                'vulnerabilityId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

aggregationType

Type: string

The aggregation type specifies what type of key is used to group the image scan findings. Image Builder returns results based on the request filter. If you didn't specify a filter in the request, the type defaults to accountId.

Aggregation types

accountId
imageBuildVersionArn
imagePipelineArn
vulnerabilityId

Each aggregation includes counts by severity level for medium severity and higher level findings, plus a total for all of the findings for each key value.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

responses

Type: Array of ImageScanFindingAggregation structures

An array of image scan finding aggregations that match the filter criteria.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImageScanFindings

$result = $client->listImageScanFindings([/* ... */]);
$promise = $client->listImageScanFindingsAsync([/* ... */]);

Returns a list of image scan findings for your account.

Parameter Syntax

$result = $client->listImageScanFindings([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of ImageScanFindingsFilter structures

An array of name value pairs that you can use to filter your results. You can use the following filters to streamline results:

imageBuildVersionArn
imagePipelineArn
vulnerabilityId
severity

If you don't request a filter, then all findings in your account are listed.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'findings' => [
        [
            'awsAccountId' => '<string>',
            'description' => '<string>',
            'firstObservedAt' => <DateTime>,
            'fixAvailable' => '<string>',
            'imageBuildVersionArn' => '<string>',
            'imagePipelineArn' => '<string>',
            'inspectorScore' => <float>,
            'inspectorScoreDetails' => [
                'adjustedCvss' => [
                    'adjustments' => [
                        [
                            'metric' => '<string>',
                            'reason' => '<string>',
                        ],
                        // ...
                    ],
                    'cvssSource' => '<string>',
                    'score' => <float>,
                    'scoreSource' => '<string>',
                    'scoringVector' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'packageVulnerabilityDetails' => [
                'cvss' => [
                    [
                        'baseScore' => <float>,
                        'scoringVector' => '<string>',
                        'source' => '<string>',
                        'version' => '<string>',
                    ],
                    // ...
                ],
                'referenceUrls' => ['<string>', ...],
                'relatedVulnerabilities' => ['<string>', ...],
                'source' => '<string>',
                'sourceUrl' => '<string>',
                'vendorCreatedAt' => <DateTime>,
                'vendorSeverity' => '<string>',
                'vendorUpdatedAt' => <DateTime>,
                'vulnerabilityId' => '<string>',
                'vulnerablePackages' => [
                    [
                        'arch' => '<string>',
                        'epoch' => <integer>,
                        'filePath' => '<string>',
                        'fixedInVersion' => '<string>',
                        'name' => '<string>',
                        'packageManager' => '<string>',
                        'release' => '<string>',
                        'remediation' => '<string>',
                        'sourceLayerHash' => '<string>',
                        'version' => '<string>',
                    ],
                    // ...
                ],
            ],
            'remediation' => [
                'recommendation' => [
                    'text' => '<string>',
                    'url' => '<string>',
                ],
            ],
            'severity' => '<string>',
            'title' => '<string>',
            'type' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

findings

Type: Array of ImageScanFinding structures

The image scan findings for your account that meet your request filter criteria.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListImages

$result = $client->listImages([/* ... */]);
$promise = $client->listImagesAsync([/* ... */]);

Returns the list of images that you have access to. Newly created images can take up to two minutes to appear in the ListImages API Results.

Parameter Syntax

$result = $client->listImages([
    'byName' => true || false,
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'includeDeprecated' => true || false,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'owner' => 'Self|Shared|Amazon|ThirdParty',
]);

Parameter Details

Members

byName

Type: boolean

Requests a list of images with a specific recipe name.

filters

Type: Array of Filter structures

Use the following filters to streamline results:

name
osVersion
platform
type
version

includeDeprecated

Type: boolean

Includes deprecated images in the response list.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

owner

Type: string

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Result Syntax

[
    'imageVersionList' => [
        [
            'arn' => '<string>',
            'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT',
            'dateCreated' => '<string>',
            'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
            'name' => '<string>',
            'osVersion' => '<string>',
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageVersionList

Type: Array of ImageVersion structures

The list of image semantic versions.

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.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListInfrastructureConfigurations

$result = $client->listInfrastructureConfigurations([/* ... */]);
$promise = $client->listInfrastructureConfigurationsAsync([/* ... */]);

Returns a list of infrastructure configurations.

Parameter Syntax

$result = $client->listInfrastructureConfigurations([
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

filters

Type: Array of Filter structures

You can filter on name to streamline results.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'infrastructureConfigurationSummaryList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'instanceProfileName' => '<string>',
            'instanceTypes' => ['<string>', ...],
            'name' => '<string>',
            'resourceTags' => ['<string>', ...],
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

infrastructureConfigurationSummaryList

Type: Array of InfrastructureConfigurationSummary structures

The list of infrastructure configurations.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns the list of tags for the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags for the specified resource.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.

ListWorkflowExecutions

$result = $client->listWorkflowExecutions([/* ... */]);
$promise = $client->listWorkflowExecutionsAsync([/* ... */]);

Returns a list of workflow runtime instance metadata objects for a specific image build version.

Parameter Syntax

$result = $client->listWorkflowExecutions([
    'imageBuildVersionArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

imageBuildVersionArn

Required: Yes
Type: string

List all workflow runtime instances for the specified image build version resource ARN.

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

Result Syntax

[
    'imageBuildVersionArn' => '<string>',
    'message' => '<string>',
    'nextToken' => '<string>',
    'requestId' => '<string>',
    'workflowExecutions' => [
        [
            'endTime' => '<string>',
            'message' => '<string>',
            'startTime' => '<string>',
            'status' => 'PENDING|SKIPPED|RUNNING|COMPLETED|FAILED|ROLLBACK_IN_PROGRESS|ROLLBACK_COMPLETED',
            'totalStepCount' => <integer>,
            'totalStepsFailed' => <integer>,
            'totalStepsSkipped' => <integer>,
            'totalStepsSucceeded' => <integer>,
            'type' => 'BUILD|TEST|DISTRIBUTION',
            'workflowBuildVersionArn' => '<string>',
            'workflowExecutionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

imageBuildVersionArn

Type: string

The resource ARN of the image build version for which you requested a list of workflow runtime details.

message

Type: string

The output message from the list action, if applicable.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

workflowExecutions

Type: Array of WorkflowExecutionMetadata structures

Contains an array of runtime details that represents each time a workflow ran for the requested image build version.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

ListWorkflowStepExecutions

$result = $client->listWorkflowStepExecutions([/* ... */]);
$promise = $client->listWorkflowStepExecutionsAsync([/* ... */]);

Shows runtime data for each step in a runtime instance of the workflow that you specify in the request.

Parameter Syntax

$result = $client->listWorkflowStepExecutions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'workflowExecutionId' => '<string>', // REQUIRED
]);

Parameter Details

Members

maxResults

Type: int

The maximum items to return in a request.

nextToken

Type: string

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

workflowExecutionId

Required: Yes
Type: string

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

Result Syntax

[
    'imageBuildVersionArn' => '<string>',
    'message' => '<string>',
    'nextToken' => '<string>',
    'requestId' => '<string>',
    'steps' => [
        [
            'action' => '<string>',
            'description' => '<string>',
            'endTime' => '<string>',
            'inputs' => '<string>',
            'message' => '<string>',
            'name' => '<string>',
            'outputs' => '<string>',
            'rollbackStatus' => 'RUNNING|COMPLETED|SKIPPED|FAILED',
            'startTime' => '<string>',
            'status' => 'PENDING|SKIPPED|RUNNING|COMPLETED|FAILED',
            'stepExecutionId' => '<string>',
        ],
        // ...
    ],
    'workflowBuildVersionArn' => '<string>',
    'workflowExecutionId' => '<string>',
]

Result Details

Members

imageBuildVersionArn

Type: string

The image build version resource ARN that's associated with the specified runtime instance of the workflow.

message

Type: string

The output message from the list action, if applicable.

nextToken

Type: string

requestId

Type: string

The request ID that uniquely identifies this request.

steps

Type: Array of WorkflowStepMetadata structures

Contains an array of runtime details that represents each step in this runtime instance of the workflow.

workflowBuildVersionArn

Type: string

The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

workflowExecutionId

Type: string

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

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidPaginationTokenException:
You have provided an invalid pagination token in your request.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

PutComponentPolicy

$result = $client->putComponentPolicy([/* ... */]);
$promise = $client->putComponentPolicyAsync([/* ... */]);

Applies a policy to a component. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutComponentPolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Parameter Syntax

$result = $client->putComponentPolicy([
    'componentArn' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

componentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the component that this policy should be applied to.

policy

Required: Yes
Type: string

The policy to apply.

Result Syntax

[
    'componentArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

componentArn

Type: string

The Amazon Resource Name (ARN) of the component that this policy was applied to.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidParameterValueException:
The value that you provided for the specified parameter is invalid.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

PutContainerRecipePolicy

$result = $client->putContainerRecipePolicy([/* ... */]);
$promise = $client->putContainerRecipePolicyAsync([/* ... */]);

Applies a policy to a container image. We recommend that you call the RAM API CreateResourceShare (https://docs.aws.amazon.com//ram/latest/APIReference/API_CreateResourceShare.html) to share resources. If you call the Image Builder API PutContainerImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy (https://docs.aws.amazon.com//ram/latest/APIReference/API_PromoteResourceShareCreatedFromPolicy.html) in order for the resource to be visible to all principals with whom the resource is shared.

Parameter Syntax

$result = $client->putContainerRecipePolicy([
    'containerRecipeArn' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

containerRecipeArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the container recipe that this policy should be applied to.

policy

Required: Yes
Type: string

The policy to apply to the container recipe.

Result Syntax

[
    'containerRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

containerRecipeArn

Type: string

The Amazon Resource Name (ARN) of the container recipe that this policy was applied to.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidParameterValueException:
The value that you provided for the specified parameter is invalid.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

PutImagePolicy

$result = $client->putImagePolicy([/* ... */]);
$promise = $client->putImagePolicyAsync([/* ... */]);

Applies a policy to an image. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImagePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Parameter Syntax

$result = $client->putImagePolicy([
    'imageArn' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the image that this policy should be applied to.

policy

Required: Yes
Type: string

The policy to apply.

Result Syntax

[
    'imageArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageArn

Type: string

The Amazon Resource Name (ARN) of the image that this policy was applied to.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidParameterValueException:
The value that you provided for the specified parameter is invalid.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

PutImageRecipePolicy

$result = $client->putImageRecipePolicy([/* ... */]);
$promise = $client->putImageRecipePolicyAsync([/* ... */]);

Applies a policy to an image recipe. We recommend that you call the RAM API CreateResourceShare to share resources. If you call the Image Builder API PutImageRecipePolicy, you must also call the RAM API PromoteResourceShareCreatedFromPolicy in order for the resource to be visible to all principals with whom the resource is shared.

Parameter Syntax

$result = $client->putImageRecipePolicy([
    'imageRecipeArn' => '<string>', // REQUIRED
    'policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

imageRecipeArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.

policy

Required: Yes
Type: string

The policy to apply.

Result Syntax

[
    'imageRecipeArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

imageRecipeArn

Type: string

The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
InvalidParameterValueException:
The value that you provided for the specified parameter is invalid.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.

StartImagePipelineExecution

$result = $client->startImagePipelineExecution([/* ... */]);
$promise = $client->startImagePipelineExecutionAsync([/* ... */]);

Manually triggers a pipeline to create an image.

Parameter Syntax

$result = $client->startImagePipelineExecution([
    'clientToken' => '<string>', // REQUIRED
    'imagePipelineArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

imagePipelineArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the image pipeline that you want to manually invoke.

Result Syntax

[
    'clientToken' => '<string>',
    'imageBuildVersionArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

imageBuildVersionArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds a tag to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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

tagKeys

Required: Yes
Type: Array of strings

The tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
InvalidParameterException:
The specified parameter is invalid. Review the available parameters for the API request.
ResourceNotFoundException:
At least one of the resources referenced by your request does not exist.

UpdateDistributionConfiguration

$result = $client->updateDistributionConfiguration([/* ... */]);
$promise = $client->updateDistributionConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateDistributionConfiguration([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'distributionConfigurationArn' => '<string>', // REQUIRED
    'distributions' => [ // REQUIRED
        [
            'amiDistributionConfiguration' => [
                'amiTags' => ['<string>', ...],
                'description' => '<string>',
                'kmsKeyId' => '<string>',
                'launchPermission' => [
                    'organizationArns' => ['<string>', ...],
                    'organizationalUnitArns' => ['<string>', ...],
                    'userGroups' => ['<string>', ...],
                    'userIds' => ['<string>', ...],
                ],
                'name' => '<string>',
                'targetAccountIds' => ['<string>', ...],
            ],
            'containerDistributionConfiguration' => [
                'containerTags' => ['<string>', ...],
                'description' => '<string>',
                'targetRepository' => [ // REQUIRED
                    'repositoryName' => '<string>', // REQUIRED
                    'service' => 'ECR', // REQUIRED
                ],
            ],
            'fastLaunchConfigurations' => [
                [
                    'accountId' => '<string>',
                    'enabled' => true || false, // REQUIRED
                    'launchTemplate' => [
                        'launchTemplateId' => '<string>',
                        'launchTemplateName' => '<string>',
                        'launchTemplateVersion' => '<string>',
                    ],
                    'maxParallelLaunches' => <integer>,
                    'snapshotConfiguration' => [
                        'targetResourceCount' => <integer>,
                    ],
                ],
                // ...
            ],
            'launchTemplateConfigurations' => [
                [
                    'accountId' => '<string>',
                    'launchTemplateId' => '<string>', // REQUIRED
                    'setDefaultVersion' => true || false,
                ],
                // ...
            ],
            'licenseConfigurationArns' => ['<string>', ...],
            'region' => '<string>', // REQUIRED
            's3ExportConfiguration' => [
                'diskImageFormat' => 'VMDK|RAW|VHD', // REQUIRED
                'roleName' => '<string>', // REQUIRED
                's3Bucket' => '<string>', // REQUIRED
                's3Prefix' => '<string>',
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token of the distribution configuration.

description

Type: string

The description of the distribution configuration.

distributionConfigurationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the distribution configuration that you want to update.

distributions

Required: Yes
Type: Array of Distribution structures

The distributions of the distribution configuration.

Result Syntax

[
    'clientToken' => '<string>',
    'distributionConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

distributionConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.
InvalidParameterCombinationException:
You have specified two or more mutually exclusive parameters. Review the error message for details.

UpdateImagePipeline

$result = $client->updateImagePipeline([/* ... */]);
$promise = $client->updateImagePipelineAsync([/* ... */]);

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.

UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

Parameter Syntax

$result = $client->updateImagePipeline([
    'clientToken' => '<string>', // REQUIRED
    'containerRecipeArn' => '<string>',
    'description' => '<string>',
    'distributionConfigurationArn' => '<string>',
    'enhancedImageMetadataEnabled' => true || false,
    'imagePipelineArn' => '<string>', // REQUIRED
    'imageRecipeArn' => '<string>',
    'imageScanningConfiguration' => [
        'ecrConfiguration' => [
            'containerTags' => ['<string>', ...],
            'repositoryName' => '<string>',
        ],
        'imageScanningEnabled' => true || false,
    ],
    'imageTestsConfiguration' => [
        'imageTestsEnabled' => true || false,
        'timeoutMinutes' => <integer>,
    ],
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'schedule' => [
        'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
        'scheduleExpression' => '<string>',
        'timezone' => '<string>',
    ],
    'status' => 'DISABLED|ENABLED',
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

containerRecipeArn

Type: string

The Amazon Resource Name (ARN) of the container pipeline to update.

description

Type: string

The description of the image pipeline.

distributionConfigurationArn

Type: string

The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.

enhancedImageMetadataEnabled

Type: boolean

imagePipelineArn

Required: Yes
Type: string

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

imageRecipeArn

Type: string

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

imageScanningConfiguration

Type: ImageScanningConfiguration structure

Contains settings for vulnerability scans.

imageTestsConfiguration

Type: ImageTestsConfiguration structure

The image test configuration of the image pipeline.

infrastructureConfigurationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.

schedule

Type: Schedule structure

The schedule of the image pipeline.

status

Type: string

The status of the image pipeline.

Result Syntax

[
    'clientToken' => '<string>',
    'imagePipelineArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

imagePipelineArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.

UpdateInfrastructureConfiguration

$result = $client->updateInfrastructureConfiguration([/* ... */]);
$promise = $client->updateInfrastructureConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateInfrastructureConfiguration([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'instanceMetadataOptions' => [
        'httpPutResponseHopLimit' => <integer>,
        'httpTokens' => '<string>',
    ],
    'instanceProfileName' => '<string>', // REQUIRED
    'instanceTypes' => ['<string>', ...],
    'keyPair' => '<string>',
    'logging' => [
        's3Logs' => [
            's3BucketName' => '<string>',
            's3KeyPrefix' => '<string>',
        ],
    ],
    'resourceTags' => ['<string>', ...],
    'securityGroupIds' => ['<string>', ...],
    'snsTopicArn' => '<string>',
    'subnetId' => '<string>',
    'terminateInstanceOnFailure' => true || false,
]);

Parameter Details

Members

clientToken

Required: Yes
Type: string

The idempotency token used to make this request idempotent.

description

Type: string

The description of the infrastructure configuration.

infrastructureConfigurationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

instanceMetadataOptions

Type: InstanceMetadataOptions structure

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

instanceProfileName

Required: Yes
Type: string

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

instanceTypes

Type: Array of strings

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.

keyPair

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

logging

Type: Logging structure

The logging configuration of the infrastructure configuration.

resourceTags

Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the resource created by Image Builder.

securityGroupIds

Type: Array of strings

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

snsTopicArn

Type: string

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

subnetId

Type: string

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

terminateInstanceOnFailure

Type: boolean

Result Syntax

[
    'clientToken' => '<string>',
    'infrastructureConfigurationArn' => '<string>',
    'requestId' => '<string>',
]

Result Details

Members

clientToken

Type: string

The idempotency token used to make this request idempotent.

infrastructureConfigurationArn

Type: string

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

requestId

Type: string

The request ID that uniquely identifies this request.

Errors

ServiceException:
This exception is thrown when the service encounters an unrecoverable exception.
ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.
ServiceUnavailableException:
The service is unable to process your request at this time.
InvalidRequestException:
You have requested an action that that the service doesn't support.
IdempotentParameterMismatchException:
You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.
ForbiddenException:
You are not authorized to perform the requested operation.
CallRateLimitExceededException:
You have exceeded the permitted request rate for the specific operation.
ResourceInUseException:
The resource that you are trying to operate on is currently in use. Review the message details and retry later.

Shapes

AccountAggregation

Description

Contains counts of vulnerability findings from image scans that run when you create new Image Builder images, or build new versions of existing images. The vulnerability counts are grouped by severity level. The counts are aggregated across resources to create the final tally for the account that owns them.

Members

accountId

Type: string

Identifies the account that owns the aggregated resource findings.

severityCounts

Type: SeverityCounts structure

Counts by severity level for medium severity and higher level findings, plus a total for all of the findings.

AdditionalInstanceConfiguration

Description

In addition to your infrastructure configuration, these settings provide an extra layer of control over your build instances. You can also specify commands to run on launch for all of your build instances.

Image Builder does not automatically install the Systems Manager agent on Windows instances. If your base image includes the Systems Manager agent, then the AMI that you create will also include the agent. For Linux instances, if the base image does not already include the Systems Manager agent, Image Builder installs it. For Linux instances where Image Builder installs the Systems Manager agent, you can choose whether to keep it for the AMI that you create.

Members

systemsManagerAgent

Type: SystemsManagerAgent structure

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

userDataOverride

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

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

Ami

Description

Details of an Amazon EC2 AMI.

Members

accountId

Type: string

The account ID of the owner of the AMI.

description

Type: string

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

image

Type: string

The AMI ID of the Amazon EC2 AMI.

name

Type: string

The name of the Amazon EC2 AMI.

region

Type: string

The Amazon Web Services Region of the Amazon EC2 AMI.

state

Type: ImageState structure

Image status and the reason for that status.

AmiDistributionConfiguration

Description

Define and configure the output AMIs of the pipeline.

Members

amiTags

Type: Associative array of custom strings keys (TagKey) to strings

The tags to apply to AMIs distributed to this Region.

description

Type: string

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

kmsKeyId

Type: string

The KMS key identifier used to encrypt the distributed image.

launchPermission

Type: LaunchPermissionConfiguration structure

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

name

Type: string

The name of the output AMI.

targetAccountIds

Type: Array of strings

Type: string

The Amazon Resource Name (ARN) of the component.

changeDescription

Type: string

The change description of the component.

data

Type: string

Component data contains the YAML document content for the component.

dateCreated

Type: string

The date that Image Builder created the component.

description

Type: string

The description of the component.

encrypted

Type: boolean

The encryption status of the component.

kmsKeyId

Type: string

The KMS key identifier used to encrypt the component.

name

Type: string

The name of the component.

obfuscate

Type: boolean

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

owner

Type: string

The owner of the component.

parameters

Type: Array of ComponentParameterDetail structures

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

platform

Type: string

The operating system platform of the component.

publisher

Type: string

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

state

Type: ComponentState structure

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

supportedOsVersions

Type: Array of strings

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.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags that apply to the component.

type

Type: string

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

version

Type: string

The version of the component.

ComponentConfiguration

Description

Configuration details of the component.

Members

componentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the component.

parameters

Type: Array of ComponentParameter structures

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

ComponentParameter

Description

Contains a key/value pair that sets the named component parameter.

Members

name

Required: Yes
Type: string

The name of the component parameter to set.

value

Required: Yes
Type: Array of strings

Sets the value for the named component parameter.

ComponentParameterDetail

Description

Defines a parameter that is used to provide configuration details for the component.

Members

defaultValue

Type: Array of strings

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

description

Type: string

Describes this parameter.

name

Required: Yes
Type: string

The name of this input parameter.

type

Required: Yes
Type: string

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

ComponentState

Description

A group of fields that describe the current status of components that are no longer active.

Members

reason

Type: string

Describes how or why the component changed state.

status

Type: string

The current state of the component.

ComponentSummary

Description

A high-level summary of a component.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the component.

changeDescription

Type: string

The change description for the current version of the component.

dateCreated

Type: string

The original creation date of the component.

description

Type: string

The description of the component.

name

Type: string

The name of the component.

obfuscate

Type: boolean

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

owner

Type: string

The owner of the component.

platform

Type: string

The operating system platform of the component.

publisher

Type: string

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

state

Type: ComponentState structure

Describes the current status of the component.

supportedOsVersions

Type: Array of strings

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags that apply to the component.

type

Type: string

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

version

Type: string

The version of the component.

ComponentVersion

Description

The defining characteristics of a specific version of an Amazon Web Services TOE component.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the component.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

dateCreated

Type: string

The date that the component was created.

description

Type: string

The description of the component.

name

Type: string

The name of the component.

owner

Type: string

The owner of the component.

platform

Type: string

The platform of the component.

supportedOsVersions

Type: Array of strings

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

type

Type: string

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

version

Type: string

The semantic version of the component.

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.

Container

Description

A container encapsulates the runtime environment for an application.

Members

imageUris

Type: Array of strings

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

region

Type: string

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

ContainerDistributionConfiguration

Description

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

Members

containerTags

Type: Array of strings

Tags that are attached to the container distribution configuration.

description

Type: string

The description of the container distribution configuration.

targetRepository

Required: Yes
Type: TargetContainerRepository structure

The destination repository for the container distribution configuration.

ContainerRecipe

Description

A container recipe.

Members

arn

Type: string

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

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

components

Type: Array of ComponentConfiguration structures

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.

containerType

Type: string

Specifies the type of container, such as Docker.

dateCreated

Type: string

The date when this container recipe was created.

description

Type: string

The description of the container recipe.

dockerfileTemplateData

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

encrypted

Type: boolean

A flag that indicates if the target container is encrypted.

instanceConfiguration

Type: InstanceConfiguration structure

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

kmsKeyId

Type: string

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

name

Type: string

The name of the container recipe.

owner

Type: string

The owner of the container recipe.

parentImage

Type: string

The base image for the container recipe.

platform

Type: string

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags that are attached to the container recipe.

targetRepository

Type: TargetContainerRepository structure

The destination repository for the container image.

version

Type: string

The semantic version of the container recipe.

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.

workingDirectory

Type: string

The working directory for use during build and test workflows.

ContainerRecipeSummary

Description

A summary of a container recipe

Members

arn

Type: string

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

containerType

Type: string

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

dateCreated

Type: string

The date when this container recipe was created.

name

Type: string

The name of the container recipe.

owner

Type: string

The owner of the container recipe.

parentImage

Type: string

The base image for the container recipe.

platform

Type: string

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags that are attached to the container recipe.

CvssScore

Description

Amazon Inspector generates a risk score for each finding. This score helps you to prioritize findings, to focus on the most critical findings and the most vulnerable resources. The score uses the Common Vulnerability Scoring System (CVSS) format. This format is a modification of the base CVSS score that the National Vulnerability Database (NVD) provides. For more information about severity levels, see Severity levels for Amazon Inspector findings in the Amazon Inspector User Guide.

Members

baseScore

Type: double

The CVSS base score.

scoringVector

Type: string

The vector string of the CVSS score.

source

Type: string

The source of the CVSS score.

version

Type: string

The CVSS version that generated the score.

CvssScoreAdjustment

Description

Details about an adjustment that Amazon Inspector made to the CVSS score for a finding.

Members

metric

Type: string

The metric that Amazon Inspector used to adjust the CVSS score.

reason

Type: string

The reason for the CVSS score adjustment.

CvssScoreDetails

Description

Details about the source of the score, and the factors that determined the adjustments to create the final score.

Members

adjustments

Type: Array of CvssScoreAdjustment structures

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

cvssSource

Type: string

The source of the finding.

score

Type: double

The CVSS score.

scoreSource

Type: string

The source for the CVSS score.

scoringVector

Type: string

A vector that measures the severity of the vulnerability.

version

Type: string

The CVSS version that generated the score.

Distribution

Description

Defines the settings for a specific Region.

Members

amiDistributionConfiguration

Type: AmiDistributionConfiguration structure

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

containerDistributionConfiguration

Type: ContainerDistributionConfiguration structure

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

fastLaunchConfigurations

Type: Array of FastLaunchConfiguration structures

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

launchTemplateConfigurations

Type: Array of LaunchTemplateConfiguration structures

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

licenseConfigurationArns

Type: Array of strings

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

region

Required: Yes
Type: string

The target Region.

s3ExportConfiguration

Type: S3ExportConfiguration structure

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.

DistributionConfiguration

Description

A distribution configuration.

Members

arn

Type: string

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

dateCreated

Type: string

The date on which this distribution configuration was created.

dateUpdated

Type: string

The date on which this distribution configuration was last updated.

description

Type: string

The description of the distribution configuration.

distributions

Type: Array of Distribution structures

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

name

Type: string

The name of the distribution configuration.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the distribution configuration.

timeoutMinutes

Required: Yes
Type: int

The maximum duration in minutes for this distribution configuration.

DistributionConfigurationSummary

Description

A high-level overview of a distribution configuration.

Members

arn

Type: string

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

dateCreated

Type: string

The date on which the distribution configuration was created.

dateUpdated

Type: string

The date on which the distribution configuration was updated.

description

Type: string

The description of the distribution configuration.

name

Type: string

The name of the distribution configuration.

regions

Type: Array of strings

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

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with the distribution configuration.

EbsInstanceBlockDeviceSpecification

Description

Amazon EBS-specific block device mapping specifications.

Members

deleteOnTermination

Type: boolean

Use to configure delete on termination of the associated device.

encrypted

Type: boolean

Use to configure device encryption.

iops

Type: int

Use to configure device IOPS.

kmsKeyId

Type: string

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

snapshotId

Type: string

The snapshot that defines the device contents.

throughput

Type: int

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

volumeSize

Type: int

Use to override the device's volume size.

volumeType

Type: string

Use to override the device's volume type.

EcrConfiguration

Description

Settings that Image Builder uses to configure the ECR repository and the output container images that Amazon Inspector scans.

Members

containerTags

Type: Array of strings

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

repositoryName

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

FastLaunchConfiguration

Description

Define and configure faster launching for output Windows AMIs.

Members

accountId

Type: string

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

enabled

Required: Yes
Type: 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.

launchTemplate

Type: FastLaunchLaunchTemplateSpecification structure

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

maxParallelLaunches

Type: int

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

snapshotConfiguration

Type: FastLaunchSnapshotConfiguration structure

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

FastLaunchLaunchTemplateSpecification

Description

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.

You can specify either the launchTemplateName or the launchTemplateId, but not both.

Members

launchTemplateId

Type: string

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

launchTemplateName

Type: string

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

launchTemplateVersion

Type: string

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

FastLaunchSnapshotConfiguration

Description

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

Members

targetResourceCount

Type: int

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

Filter

Description

Members

name

Type: string

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

values

Type: Array of strings

Type: string

The Amazon Resource Name (ARN) of the image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

buildType

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

containerRecipe

Type: ContainerRecipe structure

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.

dateCreated

Type: string

The date on which Image Builder created this image.

distributionConfiguration

Type: DistributionConfiguration structure

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

enhancedImageMetadataEnabled

Type: boolean

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

imageRecipe

Type: ImageRecipe structure

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.

imageScanningConfiguration

Type: ImageScanningConfiguration structure

Contains settings for vulnerability scans.

imageSource

Type: string

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

imageTestsConfiguration

Type: ImageTestsConfiguration structure

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

infrastructureConfiguration

Type: InfrastructureConfiguration structure

The infrastructure that Image Builder used to create this image.

name

Type: string

The name of the image.

osVersion

Type: string

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

outputResources

Type: OutputResources structure

The output resources that Image Builder produces for this image.

platform

Type: string

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

scanState

Type: ImageScanState structure

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

sourcePipelineArn

Type: string

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

sourcePipelineName

Type: string

The name of the image pipeline that created this image.

state

Type: ImageState structure

The state of the image.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags that apply to this image.

type

Type: string

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

version

Type: string

The semantic version of the image.

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.

ImageAggregation

Description

Contains vulnerability counts for a specific image.

Members

imageBuildVersionArn

Type: string

The Amazon Resource Name (ARN) that identifies the image for this aggregation.

severityCounts

Type: SeverityCounts structure

Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image.

ImagePackage

Description

Represents a package installed on an Image Builder image.

Members

packageName

Type: string

The name of the package as reported to the operating system package manager.

packageVersion

Type: string

The version of the package as reported to the operating system package manager.

ImagePipeline

Description

Details of an image pipeline.

Members

arn

Type: string

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

containerRecipeArn

Type: string

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

dateCreated

Type: string

The date on which this image pipeline was created.

dateLastRun

Type: string

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

dateNextRun

Type: string

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

dateUpdated

Type: string

The date on which this image pipeline was last updated.

description

Type: string

The description of the image pipeline.

distributionConfigurationArn

Type: string

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

enhancedImageMetadataEnabled

Type: boolean

imageRecipeArn

Type: string

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

imageScanningConfiguration

Type: ImageScanningConfiguration structure

Contains settings for vulnerability scans.

imageTestsConfiguration

Type: ImageTestsConfiguration structure

The image tests configuration of the image pipeline.

infrastructureConfigurationArn

Type: string

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

name

Type: string

The name of the image pipeline.

platform

Type: string

The platform of the image pipeline.

schedule

Type: Schedule structure

The schedule of the image pipeline.

status

Type: string

The status of the image pipeline.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of this image pipeline.

ImagePipelineAggregation

Description

Contains vulnerability counts for a specific image pipeline.

Members

imagePipelineArn

Type: string

The Amazon Resource Name (ARN) that identifies the image pipeline for this aggregation.

severityCounts

Type: SeverityCounts structure

Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified image pipeline.

ImageRecipe

Description

An image recipe.

Members

additionalInstanceConfiguration

Type: AdditionalInstanceConfiguration structure

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.

arn

Type: string

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

blockDeviceMappings

Type: Array of InstanceBlockDeviceMapping structures

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

components

Type: Array of ComponentConfiguration structures

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.

dateCreated

Type: string

The date on which this image recipe was created.

description

Type: string

The description of the image recipe.

name

Type: string

The name of the image recipe.

owner

Type: string

The owner of the image recipe.

parentImage

Type: string

The base image of the image recipe.

platform

Type: string

The platform of the image recipe.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the image recipe.

type

Type: string

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

version

Type: string

The version of the image recipe.

workingDirectory

Type: string

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

ImageRecipeSummary

Description

A summary of an image recipe.

Members

arn

Type: string

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

dateCreated

Type: string

The date on which this image recipe was created.

name

Type: string

The name of the image recipe.

owner

Type: string

The owner of the image recipe.

parentImage

Type: string

The base image of the image recipe.

platform

Type: string

The platform of the image recipe.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the image recipe.

ImageScanFinding

Description

Contains details about a vulnerability scan finding.

Members

awsAccountId

Type: string

The Amazon Web Services account ID that's associated with the finding.

description

Type: string

The description of the finding.

firstObservedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the finding was first observed.

fixAvailable

Type: string

Details about whether a fix is available for any of the packages that are identified in the finding through a version update.

imageBuildVersionArn

Type: string

The Amazon Resource Name (ARN) of the image build version that's associated with the finding.

imagePipelineArn

Type: string

The Amazon Resource Name (ARN) of the image pipeline that's associated with the finding.

inspectorScore

Type: double

The score that Amazon Inspector assigned for the finding.

inspectorScoreDetails

Type: InspectorScoreDetails structure

An object that contains details of the Amazon Inspector score.

packageVulnerabilityDetails

Type: PackageVulnerabilityDetails structure

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

remediation

Type: Remediation structure

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

severity

Type: string

The severity of the finding.

title

Type: string

The title of the finding.

type

Type: string

The type of the finding. Image Builder looks for findings of the type PACKAGE_VULNERABILITY that apply to output images, and excludes other types.

updatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the finding was last updated.

ImageScanFindingAggregation

Description

This returns exactly one type of aggregation, based on the filter that Image Builder applies in its API action.

Members

accountAggregation

Type: AccountAggregation structure

Returns an object that contains severity counts based on an account ID.

imageAggregation

Type: ImageAggregation structure

Returns an object that contains severity counts based on the Amazon Resource Name (ARN) for a specific image.

imagePipelineAggregation

Type: ImagePipelineAggregation structure

Returns an object that contains severity counts based on an image pipeline ARN.

vulnerabilityIdAggregation

Type: VulnerabilityIdAggregation structure

Returns an object that contains severity counts based on vulnerability ID.

ImageScanFindingsFilter

Description

A name value pair that Image Builder applies to streamline results from the vulnerability scan findings list action.

Members

name

Type: string

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

values

Type: Array of strings

The filter values. Filter values are case-sensitive.

ImageScanState

Description

Shows the vulnerability scan status for a specific image, and the reason for that status.

Members

reason

Type: string

The reason for the scan status for the image.

status

Type: string

The current state of vulnerability scans for the image.

ImageScanningConfiguration

Description

Contains settings for Image Builder image resource and container image scans.

Members

ecrConfiguration

Type: EcrConfiguration structure

Contains Amazon ECR settings for vulnerability scans.

imageScanningEnabled

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

ImageState

Description

Image status and the reason for that status.

Members

reason

Type: string

The reason for the status of the image.

status

Type: string

The status of the image.

ImageSummary

Description

An image summary.

Members

arn

Type: string

The Amazon Resource Name (ARN) of the image.

buildType

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

dateCreated

Type: string

The date on which Image Builder created this image.

imageSource

Type: string

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

name

Type: string

The name of the image.

osVersion

Type: string

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

outputResources

Type: OutputResources structure

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

owner

Type: string

The owner of the image.

platform

Type: string

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

state

Type: ImageState structure

The state of the image.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags that apply to this image.

type

Type: string

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

version

Type: string

The version of the image.

ImageTestsConfiguration

Description

Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.

Members

imageTestsEnabled

Type: 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

Type: int

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

The timeoutMinutes attribute is not currently active. This value is ignored.

ImageVersion

Description

The defining characteristics of a specific version of an Image Builder image.

Members

arn

Type: string

The Amazon Resource Name (ARN) of a specific version of an Image Builder image.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

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.
Version ARNs have only the first three nodes: <major>.<minor>.<patch>
Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

buildType

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

dateCreated

Type: string

The date on which this specific version of the Image Builder image was created.

imageSource

Type: string

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

name

Type: string

The name of this specific version of an Image Builder image.

osVersion

Type: string

The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

owner

Type: string

The owner of the image version.

platform

Type: string

The operating system platform of the image version, for example "Windows" or "Linux".

type

Type: string

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

version

Type: string

Details for a specific version of an Image Builder image. This version follows the semantic version syntax.

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.

InfrastructureConfiguration

Description

Details of the infrastructure configuration.

Members

arn

Type: string

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

dateCreated

Type: string

The date on which the infrastructure configuration was created.

dateUpdated

Type: string

The date on which the infrastructure configuration was last updated.

description

Type: string

The description of the infrastructure configuration.

instanceMetadataOptions

Type: InstanceMetadataOptions structure

The instance metadata option settings for the infrastructure configuration.

instanceProfileName

Type: string

The instance profile of the infrastructure configuration.

instanceTypes

Type: Array of strings

The instance types of the infrastructure configuration.

keyPair

Type: string

The Amazon EC2 key pair of the infrastructure configuration.

logging

Type: Logging structure

The logging configuration of the infrastructure configuration.

name

Type: string

The name of the infrastructure configuration.

resourceTags

Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the resource created by Image Builder.

securityGroupIds

Type: Array of strings

The security group IDs of the infrastructure configuration.

snsTopicArn

Type: string

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

subnetId

Type: string

The subnet ID of the infrastructure configuration.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the infrastructure configuration.

terminateInstanceOnFailure

Type: boolean

The terminate instance on failure configuration of the infrastructure configuration.

InfrastructureConfigurationSummary

Description

The infrastructure used when building Amazon EC2 AMIs.

Members

arn

Type: string

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

dateCreated

Type: string

The date on which the infrastructure configuration was created.

dateUpdated

Type: string

The date on which the infrastructure configuration was last updated.

description

Type: string

The description of the infrastructure configuration.

instanceProfileName

Type: string

The instance profile of the infrastructure configuration.

instanceTypes

Type: Array of strings

The instance types of the infrastructure configuration.

name

Type: string

The name of the infrastructure configuration.

resourceTags

Type: Associative array of custom strings keys (TagKey) to strings

The tags attached to the image created by Image Builder.

tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags of the infrastructure configuration.

InspectorScoreDetails

Description

Information about the factors that influenced the score that Amazon Inspector assigned for a finding.

Members

adjustedCvss

Type: CvssScoreDetails structure

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

InstanceBlockDeviceMapping

Description

Defines block device mappings for the instance used to configure your image.

Members

deviceName

Type: string

The device to which these mappings apply.

ebs

Type: EbsInstanceBlockDeviceSpecification structure

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

noDevice

Type: string

Use to remove a mapping from the base image.

virtualName

Type: string

Use to manage instance ephemeral devices.

InstanceConfiguration

Description

Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.

Members

blockDeviceMappings

Type: Array of InstanceBlockDeviceMapping structures

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

image

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

InstanceMetadataOptions

Description

The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances, or Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

Members

httpPutResponseHopLimit

Type: int

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.

httpTokens

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

Type: Array of strings

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

organizationalUnitArns

Type: Array of strings

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.

userGroups

Type: Array of strings

The name of the group.

userIds

Type: Array of strings

The Amazon Web Services account ID.

LaunchTemplateConfiguration

Description

Identifies an Amazon EC2 launch template to use for a specific account.

Members

accountId

Type: string

The account ID that this configuration applies to.

launchTemplateId

Required: Yes
Type: string

Identifies the Amazon EC2 launch template to use.

setDefaultVersion

Type: boolean

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

Logging

Description

Logging configuration defines where Image Builder uploads your logs.

Members

s3Logs

Type: S3Logs structure

The Amazon S3 logging configuration.

OutputResources

Description

The resources produced by this image.

Members

amis

Type: Array of Ami structures

The Amazon EC2 AMIs created by this image.

containers

Type: Array of Container structures

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

PackageVulnerabilityDetails

Description

Information about package vulnerability findings.

Members

cvss

Type: Array of CvssScore structures

CVSS scores for one or more vulnerabilities that Amazon Inspector identified for a package.

referenceUrls

Type: Array of strings

Links to web pages that contain details about the vulnerabilities that Amazon Inspector identified for the package.

relatedVulnerabilities

Type: Array of strings

Vulnerabilities that are often related to the findings for the package.

source

Type: string

The source of the vulnerability information.

sourceUrl

Type: string

A link to the source of the vulnerability information.

vendorCreatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

vendorSeverity

Type: string

The severity that the vendor assigned to this vulnerability type.

vendorUpdatedAt

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

vulnerabilityId

Required: Yes
Type: string

A unique identifier for this vulnerability.

vulnerablePackages

Type: Array of VulnerablePackage structures

The packages that this vulnerability impacts.

Remediation

Description

Information about how to remediate a finding.

Members

recommendation

Type: RemediationRecommendation structure

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

RemediationRecommendation

Description

Details about the recommended course of action to remediate the finding.

Members

text

Type: string

The recommended course of action to remediate the finding.

url

Type: string

Required: Yes
Type: 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.

roleName

Required: Yes
Type: string

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

s3Bucket

Required: Yes
Type: string

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

s3Prefix

Type: string

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

S3Logs

Description

Amazon S3 logging configuration.

Members

s3BucketName

Type: string

The S3 bucket in which to store the logs.

s3KeyPrefix

Type: string

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

Schedule

Description

A schedule configures how often and when a pipeline will automatically create a new image.

Members

pipelineExecutionStartCondition

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

scheduleExpression

Type: 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

Type: string

Type: long (int|float)

The total number of findings across all severity levels for the specified filter.

critical

Type: long (int|float)

The number of critical severity findings for the specified filter.

high

Type: long (int|float)

The number of high severity findings for the specified filter.

medium

Type: long (int|float)

The number of medium severity findings for the specified filter.

SystemsManagerAgent

Description

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

Members

uninstallAfterBuild

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

TargetContainerRepository

Description

The container repository where the output container image is stored.

Members

repositoryName

Required: Yes
Type: string

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

service

Required: Yes
Type: string

Specifies the service in which this image was registered.

VulnerabilityIdAggregation

Description

Includes counts of image and pipeline resource findings by vulnerability.

Members

severityCounts

Type: SeverityCounts structure

Counts by severity level for medium severity and higher level findings, plus a total for all of the findings for the specified vulnerability.

vulnerabilityId

Type: string

The vulnerability Id for this set of counts.

VulnerablePackage

Description

Information about a vulnerable package that Amazon Inspector identifies in a finding.

Members

arch

Type: string

The architecture of the vulnerable package.

epoch

Type: int

The epoch of the vulnerable package.

filePath

Type: string

The file path of the vulnerable package.

fixedInVersion

Type: string

The version of the package that contains the vulnerability fix.

name

Type: string

The name of the vulnerable package.

packageManager

Type: string

The package manager of the vulnerable package.

release

Type: string

The release of the vulnerable package.

remediation

Type: string

The code to run in your environment to update packages with a fix available.

sourceLayerHash

Type: string

The source layer hash of the vulnerable package.

version

Type: string

The version of the vulnerable package.

WorkflowExecutionMetadata

Description

Metadata that includes details and status from this runtime instance of the workflow.

Members

endTime

Type: string

The timestamp when this runtime instance of the workflow finished.

message

Type: string

The runtime output message from the workflow, if applicable.

startTime

Type: string

The timestamp when the runtime instance of this workflow started.

status

Type: string

The current runtime status for this workflow.

totalStepCount

Type: int

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

totalStepsFailed

Type: int

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

totalStepsSkipped

Type: int

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

totalStepsSucceeded

Type: int

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

type

Type: string

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

workflowBuildVersionArn

Type: string

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

workflowExecutionId

Type: string

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

WorkflowStepMetadata

Description

Runtime details and status for the workflow step.

Members

action

Type: string

The step action name.

description

Type: string

Description of the workflow step.

endTime

Type: string

The timestamp when the workflow step finished.

inputs

Type: string

Input parameters that Image Builder provides for the workflow step.

message

Type: string

Detailed output message that the workflow step provides at runtime.

name

Type: string

The name of the workflow step.

outputs

Type: string

The file names that the workflow step created as output for this runtime instance of the workflow.

rollbackStatus

Type: string

Reports on the rollback status of the step, if applicable.

startTime

Type: string

The timestamp when the workflow step started.

status

Type: string

Runtime status for the workflow step.

stepExecutionId

Type: string

A unique identifier for the workflow step, assigned at runtime.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

EC2 Image Builder 2019-12-02

Operation Summary

Paginators

Operations

CancelImageCreation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateComponent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateContainerRecipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDistributionConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateImage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateImagePipeline

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateImageRecipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateInfrastructureConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteComponent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details