EC2 Image Builder 2019-12-02

CancelImageCreation

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

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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>',
                    'volumeSize' => <integer>,
                    'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                ],
                'noDevice' => '<string>',
                'virtualName' => '<string>',
            ],
            // ...
        ],
        'image' => '<string>',
    ],
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'parentImage' => '<string>', // REQUIRED
    'platformOverride' => 'Windows|Linux',
    'semanticVersion' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetRepository' => [ // REQUIRED
        'repositoryName' => '<string>', // REQUIRED
        'service' => 'ECR', // REQUIRED
    ],
    'workingDirectory' => '<string>',
]);

Parameter Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

$result = $client->createDistributionConfiguration([
    'clientToken' => '<string>', // REQUIRED
    'description' => '<string>',
    'distributions' => [ // REQUIRED
        [
            'amiDistributionConfiguration' => [
                'amiTags' => ['<string>', ...],
                'description' => '<string>',
                'kmsKeyId' => '<string>',
                'launchPermission' => [
                    'userGroups' => ['<string>', ...],
                    'userIds' => ['<string>', ...],
                ],
                'name' => '<string>',
                'targetAccountIds' => ['<string>', ...],
            ],
            'containerDistributionConfiguration' => [
                'containerTags' => ['<string>', ...],
                'description' => '<string>',
                'targetRepository' => [ // REQUIRED
                    'repositoryName' => '<string>', // REQUIRED
                    'service' => 'ECR', // REQUIRED
                ],
            ],
            'launchTemplateConfigurations' => [
                [
                    'accountId' => '<string>',
                    'launchTemplateId' => '<string>', // REQUIRED
                    'setDefaultVersion' => true || false,
                ],
                // ...
            ],
            'licenseConfigurationArns' => ['<string>', ...],
            'region' => '<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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

$result = $client->createImageRecipe([
    'additionalInstanceConfiguration' => [
        'systemsManagerAgent' => [
            'uninstallAfterBuild' => true || false,
        ],
        'userDataOverride' => '<string>',
    ],
    'blockDeviceMappings' => [
        [
            'deviceName' => '<string>',
            'ebs' => [
                'deleteOnTermination' => true || false,
                'encrypted' => true || false,
                'iops' => <integer>,
                'kmsKeyId' => '<string>',
                'snapshotId' => '<string>',
                '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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

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 made a request for an action that is not supported by the service.

• IdempotentParameterMismatchException:

  You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

• ForbiddenException:

  You are not authorized to perform the requested operation.

• CallRateLimitExceededException:

  You have exceeded the permitted request rate for the specific operation.

• ResourceInUseException:

  The resource that you are trying to operate on is currently in use. Review the message details and retry later.

• ResourceAlreadyExistsException:

  The resource that you are trying to create already exists.

• ServiceQuotaExceededException:

  You have exceeded the number of permitted resources or operations for this service. For service quotas, see EC2 Image Builder endpoints and quotas.

DeleteComponent

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

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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>',
        'owner' => '<string>',
        'parameters' => [
            [
                'defaultValue' => ['<string>', ...],
                'description' => '<string>',
                'name' => '<string>',
                'type' => '<string>',
            ],
            // ...
        ],
        'platform' => 'Windows|Linux',
        '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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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>',
                        'volumeSize' => <integer>,
                        'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                    ],
                    'noDevice' => '<string>',
                    'virtualName' => '<string>',
                ],
                // ...
            ],
            'image' => '<string>',
        ],
        'kmsKeyId' => '<string>',
        'name' => '<string>',
        'owner' => '<string>',
        'parentImage' => '<string>',
        'platform' => 'Windows|Linux',
        'tags' => ['<string>', ...],
        'targetRepository' => [
            'repositoryName' => '<string>',
            'service' => 'ECR',
        ],
        'version' => '<string>',
        'workingDirectory' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'name' => '<string>',
                    'targetAccountIds' => ['<string>', ...],
                ],
                'containerDistributionConfiguration' => [
                    'containerTags' => ['<string>', ...],
                    'description' => '<string>',
                    'targetRepository' => [
                        'repositoryName' => '<string>',
                        'service' => 'ECR',
                    ],
                ],
                'launchTemplateConfigurations' => [
                    [
                        'accountId' => '<string>',
                        'launchTemplateId' => '<string>',
                        'setDefaultVersion' => true || false,
                    ],
                    // ...
                ],
                'licenseConfigurationArns' => ['<string>', ...],
                'region' => '<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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'image' => [
        'arn' => '<string>',
        '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>',
                            'volumeSize' => <integer>,
                            'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                        ],
                        'noDevice' => '<string>',
                        'virtualName' => '<string>',
                    ],
                    // ...
                ],
                'image' => '<string>',
            ],
            'kmsKeyId' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
            'targetRepository' => [
                'repositoryName' => '<string>',
                'service' => 'ECR',
            ],
            'version' => '<string>',
            'workingDirectory' => '<string>',
        ],
        'dateCreated' => '<string>',
        'distributionConfiguration' => [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'distributions' => [
                [
                    'amiDistributionConfiguration' => [
                        'amiTags' => ['<string>', ...],
                        'description' => '<string>',
                        'kmsKeyId' => '<string>',
                        'launchPermission' => [
                            'userGroups' => ['<string>', ...],
                            'userIds' => ['<string>', ...],
                        ],
                        'name' => '<string>',
                        'targetAccountIds' => ['<string>', ...],
                    ],
                    'containerDistributionConfiguration' => [
                        'containerTags' => ['<string>', ...],
                        'description' => '<string>',
                        'targetRepository' => [
                            'repositoryName' => '<string>',
                            'service' => 'ECR',
                        ],
                    ],
                    'launchTemplateConfigurations' => [
                        [
                            'accountId' => '<string>',
                            'launchTemplateId' => '<string>',
                            'setDefaultVersion' => true || false,
                        ],
                        // ...
                    ],
                    'licenseConfigurationArns' => ['<string>', ...],
                    'region' => '<string>',
                ],
                // ...
            ],
            'name' => '<string>',
            'tags' => ['<string>', ...],
            'timeoutMinutes' => <integer>,
        ],
        'enhancedImageMetadataEnabled' => true || false,
        'imageRecipe' => [
            'additionalInstanceConfiguration' => [
                'systemsManagerAgent' => [
                    'uninstallAfterBuild' => true || false,
                ],
                'userDataOverride' => '<string>',
            ],
            'arn' => '<string>',
            'blockDeviceMappings' => [
                [
                    'deviceName' => '<string>',
                    'ebs' => [
                        'deleteOnTermination' => true || false,
                        'encrypted' => true || false,
                        'iops' => <integer>,
                        'kmsKeyId' => '<string>',
                        'snapshotId' => '<string>',
                        'volumeSize' => <integer>,
                        'volumeType' => 'standard|io1|io2|gp2|gp3|sc1|st1',
                    ],
                    'noDevice' => '<string>',
                    'virtualName' => '<string>',
                ],
                // ...
            ],
            'components' => [
                [
                    'componentArn' => '<string>',
                    'parameters' => [
                        [
                            'name' => '<string>',
                            'value' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'parentImage' => '<string>',
            'platform' => 'Windows|Linux',
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
            'workingDirectory' => '<string>',
        ],
        'imageTestsConfiguration' => [
            'imageTestsEnabled' => true || false,
            'timeoutMinutes' => <integer>,
        ],
        'infrastructureConfiguration' => [
            'arn' => '<string>',
            'dateCreated' => '<string>',
            'dateUpdated' => '<string>',
            'description' => '<string>',
            'instanceProfileName' => '<string>',
            'instanceTypes' => ['<string>', ...],
            'keyPair' => '<string>',
            'logging' => [
                's3Logs' => [
                    's3BucketName' => '<string>',
                    's3KeyPrefix' => '<string>',
                ],
            ],
            'name' => '<string>',
            'resourceTags' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'snsTopicArn' => '<string>',
            'subnetId' => '<string>',
            'tags' => ['<string>', ...],
            'terminateInstanceOnFailure' => true || false,
        ],
        'name' => '<string>',
        'osVersion' => '<string>',
        'outputResources' => [
            'amis' => [
                [
                    'accountId' => '<string>',
                    'description' => '<string>',
                    'image' => '<string>',
                    'name' => '<string>',
                    'region' => '<string>',
                    'state' => [
                        'reason' => '<string>',
                        'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
                    ],
                ],
                // ...
            ],
            'containers' => [
                [
                    'imageUris' => ['<string>', ...],
                    'region' => '<string>',
                ],
                // ...
            ],
        ],
        'platform' => 'Windows|Linux',
        'sourcePipelineArn' => '<string>',
        'sourcePipelineName' => '<string>',
        'state' => [
            'reason' => '<string>',
            'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
        ],
        'tags' => ['<string>', ...],
        'type' => 'AMI|DOCKER',
        'version' => '<string>',
    ],
    'requestId' => '<string>',
]

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

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 made a request for an action that is not supported by the service.

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

ListComponentBuildVersions

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'componentSummaryList' => [
        [
            'arn' => '<string>',
            'changeDescription' => '<string>',
            'dateCreated' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            '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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'imageSummaryList' => [
        [
            'arn' => '<string>',
            'dateCreated' => '<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',
                        ],
                    ],
                    // ...
                ],
                'containers' => [
                    [
                        'imageUris' => ['<string>', ...],
                        'region' => '<string>',
                    ],
                    // ...
                ],
            ],
            'owner' => '<string>',
            'platform' => 'Windows|Linux',
            'state' => [
                'reason' => '<string>',
                'status' => 'PENDING|CREATING|BUILDING|TESTING|DISTRIBUTING|INTEGRATING|AVAILABLE|CANCELLED|FAILED|DEPRECATED|DELETED',
            ],
            'tags' => ['<string>', ...],
            'type' => 'AMI|DOCKER',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'requestId' => '<string>',
]

Result Details

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 made a request for an action that is not supported by the service.

• 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([/* ... */]);

Parameter Syntax