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

Result Syntax

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

Result Details

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.

CancelLifecycleExecution

$result = $client->cancelLifecycleExecution([/* ... */]);
$promise = $client->cancelLifecycleExecutionAsync([/* ... */]);

Cancel a specific image lifecycle policy runtime instance.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'lifecycleExecutionId' => '<string>',
]

Result Details

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|macOS', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'supportedOsVersions' => ['<string>', ...],
    'tags' => ['<string>', ...],
    'uri' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

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|macOS',
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetRepository' => [ // REQUIRED
        'repositoryName' => '<string>', // REQUIRED
        'service' => 'ECR', // REQUIRED
    ],
    'workingDirectory' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

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>',
            ],
            'ssmParameterConfigurations' => [
                [
                    'amiAccountId' => '<string>',
                    'dataType' => 'text|aws:ec2:image',
                    'parameterName' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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,
    'executionRole' => '<string>',
    'imageRecipeArn' => '<string>',
    'imageScanningConfiguration' => [
        'ecrConfiguration' => [
            'containerTags' => ['<string>', ...],
            'repositoryName' => '<string>',
        ],
        'imageScanningEnabled' => true || false,
    ],
    'imageTestsConfiguration' => [
        'imageTestsEnabled' => true || false,
        'timeoutMinutes' => <integer>,
    ],
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'loggingConfiguration' => [
        'logGroupName' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'workflows' => [
        [
            'onFailure' => 'CONTINUE|ABORT',
            'parallelGroup' => '<string>',
            'parameters' => [
                [
                    'name' => '<string>', // REQUIRED
                    'value' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'workflowArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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,
    'executionRole' => '<string>',
    'imageRecipeArn' => '<string>',
    'imageScanningConfiguration' => [
        'ecrConfiguration' => [
            'containerTags' => ['<string>', ...],
            'repositoryName' => '<string>',
        ],
        'imageScanningEnabled' => true || false,
    ],
    'imageTestsConfiguration' => [
        'imageTestsEnabled' => true || false,
        'timeoutMinutes' => <integer>,
    ],
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'loggingConfiguration' => [
        'imageLogGroupName' => '<string>',
        'pipelineLogGroupName' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'schedule' => [
        'autoDisablePolicy' => [
            'failureCount' => <integer>, // REQUIRED
        ],
        'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
        'scheduleExpression' => '<string>',
        'timezone' => '<string>',
    ],
    'status' => 'DISABLED|ENABLED',
    'tags' => ['<string>', ...],
    'workflows' => [
        [
            'onFailure' => 'CONTINUE|ABORT',
            'parallelGroup' => '<string>',
            'parameters' => [
                [
                    'name' => '<string>', // REQUIRED
                    'value' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'workflowArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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>',
    ],
    'amiTags' => ['<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

Result Syntax

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

Result Details

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
    'placement' => [
        'availabilityZone' => '<string>',
        'hostId' => '<string>',
        'hostResourceGroupArn' => '<string>',
        'tenancy' => 'default|dedicated|host',
    ],
    'resourceTags' => ['<string>', ...],
    'securityGroupIds' => ['<string>', ...],
    'snsTopicArn' => '<string>',
    'subnetId' => '<string>',
    'tags' => ['<string>', ...],
    'terminateInstanceOnFailure' => true || false,
]);

Parameter Details

Result Syntax

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

Result Details

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.

CreateLifecyclePolicy

$result = $client->createLifecyclePolicy([/* ... */]);
$promise = $client->createLifecyclePolicyAsync([/* ... */]);

Create a lifecycle policy resource.

Parameter Syntax

$result = $client->createLifecyclePolicy([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'executionRole' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'policyDetails' => [ // REQUIRED
        [
            'action' => [ // REQUIRED
                'includeResources' => [
                    'amis' => true || false,
                    'containers' => true || false,
                    'snapshots' => true || false,
                ],
                'type' => 'DELETE|DEPRECATE|DISABLE', // REQUIRED
            ],
            'exclusionRules' => [
                'amis' => [
                    'isPublic' => true || false,
                    'lastLaunched' => [
                        'unit' => 'DAYS|WEEKS|MONTHS|YEARS', // REQUIRED
                        'value' => <integer>, // REQUIRED
                    ],
                    'regions' => ['<string>', ...],
                    'sharedAccounts' => ['<string>', ...],
                    'tagMap' => ['<string>', ...],
                ],
                'tagMap' => ['<string>', ...],
            ],
            'filter' => [ // REQUIRED
                'retainAtLeast' => <integer>,
                'type' => 'AGE|COUNT', // REQUIRED
                'unit' => 'DAYS|WEEKS|MONTHS|YEARS',
                'value' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'resourceSelection' => [ // REQUIRED
        'recipes' => [
            [
                'name' => '<string>', // REQUIRED
                'semanticVersion' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'tagMap' => ['<string>', ...],
    ],
    'resourceType' => 'AMI_IMAGE|CONTAINER_IMAGE', // REQUIRED
    'status' => 'DISABLED|ENABLED',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'lifecyclePolicyArn' => '<string>',
]

Result Details

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.

CreateWorkflow

$result = $client->createWorkflow([/* ... */]);
$promise = $client->createWorkflowAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createWorkflow([
    'changeDescription' => '<string>',
    'clientToken' => '<string>', // REQUIRED
    'data' => '<string>',
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'BUILD|TEST|DISTRIBUTION', // REQUIRED
    'uri' => '<string>',
]);

Parameter Details

Result Syntax

[
    'clientToken' => '<string>',
    'workflowBuildVersionArn' => '<string>',
]

Result Details

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.

DeleteComponent

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

Deletes a component build version.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

DeleteLifecyclePolicy

$result = $client->deleteLifecyclePolicy([/* ... */]);
$promise = $client->deleteLifecyclePolicyAsync([/* ... */]);

Delete the specified lifecycle policy resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'lifecyclePolicyArn' => '<string>',
]

Result Details

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.

DeleteWorkflow

$result = $client->deleteWorkflow([/* ... */]);
$promise = $client->deleteWorkflowAsync([/* ... */]);

Deletes a specific workflow resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'workflowBuildVersionArn' => '<string>',
]

Result Details

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

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|macOS',
        'productCodes' => [
            [
                'productCodeId' => '<string>',
                'productCodeType' => 'marketplace',
            ],
            // ...
        ],
        'publisher' => '<string>',
        'state' => [
            'reason' => '<string>',
            'status' => 'DEPRECATED|DISABLED|ACTIVE',
        ],
        'supportedOsVersions' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'type' => 'BUILD|TEST',
        'version' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

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|macOS',
        'tags' => ['<string>', ...],
        'targetRepository' => [
            'repositoryName' => '<string>',
            'service' => 'ECR',
        ],
        'version' => '<string>',
        'workingDirectory' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

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>',
                ],
                'ssmParameterConfigurations' => [
                    [
                        'amiAccountId' => '<string>',
                        'dataType' => 'text|aws:ec2:image',
                        'parameterName' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'timeoutMinutes' => <integer>,
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

[
    'image' => [
        'arn' => '<string>',
        'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT|IMPORT_ISO',
        '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|macOS',
            'tags' => ['<string>', ...],
            'targetRepository' => [
                'repositoryName' => '<string>',
                'service' => 'ECR',
            ],
            'version' => '<string>',
            'workingDirectory' => '<string>',
        ],
        'dateCreated' => '<string>',
        'deprecationTime' => <DateTime>,
        '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>',
                    ],
                    'ssmParameterConfigurations' => [
                        [
                            'amiAccountId' => '<string>',
                            'dataType' => 'text|aws:ec2:image',
                            'parameterName' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'timeoutMinutes' => <integer>,
        ],
        'enhancedImageMetadataEnabled' => true || false,
        'executionRole' => '<string>',
        'imageRecipe' => [
            'additionalInstanceConfiguration' => [
                'systemsManagerAgent' => [
                    'uninstallAfterBuild' => true || false,
                ],
                'userDataOverride' => '<string>',
            ],
            'amiTags' => ['<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|macOS',
            '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>',
            'placement' => [
                'availabilityZone' => '<string>',
                'hostId' => '<string>',
                'hostResourceGroupArn' => '<string>',
                'tenancy' => 'default|dedicated|host',
            ],
            'resourceTags' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'snsTopicArn' => '<string>',
            'subnetId' => '<string>',
            'tags' => ['<string>', ...],
            'terminateInstanceOnFailure' => true || false,
        ],
        'lifecycleExecutionId' => '<string>',
        'loggingConfiguration' => [
            'logGroupName' => '<string>',
        ],
        '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|DISABLED',
                    ],
                ],
                // ...
            ],
            'containers' => [
                [
                    'imageUris' => ['<string>', ...],
                    'region' => '<string>',
                ],
                // ...
            ],
        ],
        'platform' => 'Windows|Linux|macOS',
        '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|DISABLED',
        ],
        'tags' => ['<string>', ...],
        'type' => 'AMI|DOCKER',
        'version' => '<string>',
        'workflows' => [
            [
                'onFailure' => 'CONTINUE|ABORT',
                'parallelGroup' => '<string>',
                'parameters' => [
                    [
                        'name' => '<string>',
                        'value' => ['<string>', ...],
                    ],
                    // ...
                ],
                'workflowArn' => '<string>',
            ],
            // ...
        ],
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

[
    'imagePipeline' => [
        'arn' => '<string>',
        'consecutiveFailures' => <integer>,
        'containerRecipeArn' => '<string>',
        'dateCreated' => '<string>',
        'dateLastRun' => '<string>',
        'dateNextRun' => '<string>',
        'dateUpdated' => '<string>',
        'description' => '<string>',
        'distributionConfigurationArn' => '<string>',
        'enhancedImageMetadataEnabled' => true || false,
        'executionRole' => '<string>',
        'imageRecipeArn' => '<string>',
        'imageScanningConfiguration' => [
            'ecrConfiguration' => [
                'containerTags' => ['<string>', ...],
                'repositoryName' => '<string>',
            ],
            'imageScanningEnabled' => true || false,
        ],
        'imageTestsConfiguration' => [
            'imageTestsEnabled' => true || false,
            'timeoutMinutes' => <integer>,
        ],
        'infrastructureConfigurationArn' => '<string>',
        'lastRunStatus' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED|DISABLED',
        'loggingConfiguration' => [
            'imageLogGroupName' => '<string>',
            'pipelineLogGroupName' => '<string>',
        ],
        'name' => '<string>',
        'platform' => 'Windows|Linux|macOS',
        'schedule' => [
            'autoDisablePolicy' => [
                'failureCount' => <integer>,
            ],
            'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
            'scheduleExpression' => '<string>',
            'timezone' => '<string>',
        ],
        'status' => 'DISABLED|ENABLED',
        'tags' => ['<string>', ...],
        'workflows' => [
            [
                'onFailure' => 'CONTINUE|ABORT',
                'parallelGroup' => '<string>',
                'parameters' => [
                    [
                        'name' => '<string>',
                        'value' => ['<string>', ...],
                    ],
                    // ...
                ],
                'workflowArn' => '<string>',
            ],
            // ...
        ],
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'imageRecipe' => [
        'additionalInstanceConfiguration' => [
            'systemsManagerAgent' => [
                'uninstallAfterBuild' => true || false,
            ],
            'userDataOverride' => '<string>',
        ],
        'amiTags' => ['<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|macOS',
        'tags' => ['<string>', ...],
        'type' => 'AMI|DOCKER',
        'version' => '<string>',
        'workingDirectory' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

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>',
        'placement' => [
            'availabilityZone' => '<string>',
            'hostId' => '<string>',
            'hostResourceGroupArn' => '<string>',
            'tenancy' => 'default|dedicated|host',
        ],
        'resourceTags' => ['<string>', ...],
        'securityGroupIds' => ['<string>', ...],
        'snsTopicArn' => '<string>',
        'subnetId' => '<string>',
        'tags' => ['<string>', ...],
        'terminateInstanceOnFailure' => true || false,
    ],
    'requestId' => '<string>',
]

Result Details

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.

GetLifecycleExecution

$result = $client->getLifecycleExecution([/* ... */]);
$promise = $client->getLifecycleExecutionAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'lifecycleExecution' => [
        'endTime' => <DateTime>,
        'lifecycleExecutionId' => '<string>',
        'lifecyclePolicyArn' => '<string>',
        'resourcesImpactedSummary' => [
            'hasImpactedResources' => true || false,
        ],
        'startTime' => <DateTime>,
        'state' => [
            'reason' => '<string>',
            'status' => 'IN_PROGRESS|CANCELLED|CANCELLING|FAILED|SUCCESS|PENDING',
        ],
    ],
]

Result Details

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.

GetLifecyclePolicy

$result = $client->getLifecyclePolicy([/* ... */]);
$promise = $client->getLifecyclePolicyAsync([/* ... */]);

Get details for the specified image lifecycle policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'lifecyclePolicy' => [
        'arn' => '<string>',
        'dateCreated' => <DateTime>,
        'dateLastRun' => <DateTime>,
        'dateUpdated' => <DateTime>,
        'description' => '<string>',
        'executionRole' => '<string>',
        'name' => '<string>',
        'policyDetails' => [
            [
                'action' => [
                    'includeResources' => [
                        'amis' => true || false,
                        'containers' => true || false,
                        'snapshots' => true || false,
                    ],
                    'type' => 'DELETE|DEPRECATE|DISABLE',
                ],
                'exclusionRules' => [
                    'amis' => [
                        'isPublic' => true || false,
                        'lastLaunched' => [
                            'unit' => 'DAYS|WEEKS|MONTHS|YEARS',
                            'value' => <integer>,
                        ],
                        'regions' => ['<string>', ...],
                        'sharedAccounts' => ['<string>', ...],
                        'tagMap' => ['<string>', ...],
                    ],
                    'tagMap' => ['<string>', ...],
                ],
                'filter' => [
                    'retainAtLeast' => <integer>,
                    'type' => 'AGE|COUNT',
                    'unit' => 'DAYS|WEEKS|MONTHS|YEARS',
                    'value' => <integer>,
                ],
            ],
            // ...
        ],
        'resourceSelection' => [
            'recipes' => [
                [
                    'name' => '<string>',
                    'semanticVersion' => '<string>',
                ],
                // ...
            ],
            'tagMap' => ['<string>', ...],
        ],
        'resourceType' => 'AMI_IMAGE|CONTAINER_IMAGE',
        'status' => 'DISABLED|ENABLED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

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.

GetMarketplaceResource

$result = $client->getMarketplaceResource([/* ... */]);
$promise = $client->getMarketplaceResourceAsync([/* ... */]);

Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.

Parameter Syntax

$result = $client->getMarketplaceResource([
    'resourceArn' => '<string>', // REQUIRED
    'resourceLocation' => '<string>',
    'resourceType' => 'COMPONENT_DATA|COMPONENT_ARTIFACT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'data' => '<string>',
    'resourceArn' => '<string>',
    'url' => '<string>',
]

Result Details

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.

GetWorkflow

$result = $client->getWorkflow([/* ... */]);
$promise = $client->getWorkflowAsync([/* ... */]);

Get a workflow resource object.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'workflow' => [
        'arn' => '<string>',
        'changeDescription' => '<string>',
        'data' => '<string>',
        'dateCreated' => '<string>',
        'description' => '<string>',
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'parameters' => [
            [
                'defaultValue' => ['<string>', ...],
                'description' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'state' => [
            'reason' => '<string>',
            'status' => 'DEPRECATED',
        ],
        'tags' => ['<string>', ...],
        'type' => 'BUILD|TEST|DISTRIBUTION',
        'version' => '<string>',
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

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|CANCELLED',
    'stepExecutionId' => '<string>',
    'timeoutSeconds' => <integer>,
    'workflowBuildVersionArn' => '<string>',
    'workflowExecutionId' => '<string>',
]

Result Details

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|macOS', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'BUILD|TEST', // REQUIRED
    'uri' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

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.

ImportDiskImage

$result = $client->importDiskImage([/* ... */]);
$promise = $client->importDiskImageAsync([/* ... */]);

Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

• Windows 11 Enterprise

Parameter Syntax

$result = $client->importDiskImage([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'executionRole' => '<string>',
    'infrastructureConfigurationArn' => '<string>', // REQUIRED
    'loggingConfiguration' => [
        'logGroupName' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'osVersion' => '<string>', // REQUIRED
    'platform' => '<string>', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'uri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

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>',
    'loggingConfiguration' => [
        'logGroupName' => '<string>',
    ],
    'name' => '<string>', // REQUIRED
    'osVersion' => '<string>',
    'platform' => 'Windows|Linux|macOS', // REQUIRED
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'vmImportTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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 component version Amazon Resource Name (ARN).

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'componentVersionList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'platform' => 'Windows|Linux|macOS',
            'productCodes' => [
                [
                    'productCodeId' => '<string>',
                    'productCodeType' => 'marketplace',
                ],
                // ...
            ],
            'status' => 'DEPRECATED|DISABLED|ACTIVE',
            'supportedOsVersions' => ['<string>', ...],
            'type' => 'BUILD|TEST',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

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|AWSMarketplace',
]);

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'imageSummaryList' => [
        [
            'arn' => '<string>',
            'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT|IMPORT_ISO',
            'dateCreated' => '<string>',
            'deprecationTime' => <DateTime>,
            'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
            'lifecycleExecutionId' => '<string>',
            'loggingConfiguration' => [
                'logGroupName' => '<string>',
            ],
            '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|DISABLED',
                        ],
                    ],
                    // ...
                ],
                'containers' => [
                    [
                        'imageUris' => ['<string>', ...],
                        'region' => '<string>',
                    ],
                    // ...
                ],
            ],
            'owner' => '<string>',
            'platform' => 'Windows|Linux|macOS',
            'state' => [
                'reason' => '<string>',
                'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED|DISABLED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[
    'imageSummaryList' => [
        [
            'arn' => '<string>',
            'buildType' => 'USER_INITIATED|SCHEDULED|IMPORT|IMPORT_ISO',
            'dateCreated' => '<string>',
            'deprecationTime' => <DateTime>,
            'imageSource' => 'AMAZON_MANAGED|AWS_MARKETPLACE|IMPORTED|CUSTOM',
            'lifecycleExecutionId' => '<string>',
            'loggingConfiguration' => [
                'logGroupName' => '<string>',
            ],
            '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|DISABLED',
                        ],
                    ],
                    // ...
                ],
                'containers' => [
                    [
                        'imageUris' => ['<string>', ...],
                        'region' => '<string>',
                    ],
                    // ...
                ],
            ],
            'owner' => '<string>',
            'platform' => 'Windows|Linux|macOS',
            'state' => [
                'reason' => '<string>',
                'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED|DISABLED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

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

Result Syntax

[
    'imagePipelineList' => [
        [
            'arn' => '<string>',
            'consecutiveFailures' => <integer>,
            'containerRecipeArn' => '<string>',
            'dateCreated' => '<string>',
            'dateLastRun' => '<string>',
            'dateNextRun' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'distributionConfigurationArn' => '<string>',
            'enhancedImageMetadataEnabled' => true || false,
            'executionRole' => '<string>',
            'imageRecipeArn' => '<string>',
            'imageScanningConfiguration' => [
                'ecrConfiguration' => [
                    'containerTags' => ['<string>', ...],
                    'repositoryName' => '<string>',
                ],
                'imageScanningEnabled' => true || false,
            ],
            'imageTestsConfiguration' => [
                'imageTestsEnabled' => true || false,
                'timeoutMinutes' => <integer>,
            ],
            'infrastructureConfigurationArn' => '<string>',
            'lastRunStatus' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED|DISABLED',
            'loggingConfiguration' => [
                'imageLogGroupName' => '<string>',
                'pipelineLogGroupName' => '<string>',
            ],
            'name' => '<string>',
            'platform' => 'Windows|Linux|macOS',
            'schedule' => [
                'autoDisablePolicy' => [
                    'failureCount' => <integer>,
                ],
                'pipelineExecutionStartCondition' => 'EXPRESSION_MATCH_ONLY|EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE',
                'scheduleExpression' => '<string>',
                'timezone' => '<string>',
            ],
            'status' => 'DISABLED|ENABLED',
            'tags' => ['<string>', ...],
            'workflows' => [
                [
                    'onFailure' => 'CONTINUE|ABORT',
                    'parallelGroup' => '<string>',
                    'parameters' => [
                        [
                            'name' => '<string>',
                            'value' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'workflowArn' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

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|AWSMarketplace',
]);

Parameter Details

Result Syntax

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

Result Details

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

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

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