DeleteInfrastructureConfiguration
Deletes an infrastructure configuration.
Request Syntax
DELETE /DeleteInfrastructureConfiguration?
infrastructureConfigurationArn=infrastructureConfigurationArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
infrastructureConfigurationArn (p. 63)
The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{ "infrastructureConfigurationArn": "string", "requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
infrastructureConfigurationArn (p. 63)
The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
Type: String
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$
requestId (p. 63)
The request ID that uniquely identifies this request.
Errors
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 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.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ResourceDependencyException
You have attempted to mutate or delete a resource with a dependency that prohibits this action. See the error message for more details.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetComponent
GetComponent
Gets a component object.
Request Syntax
GET /GetComponent?componentBuildVersionArn=componentBuildVersionArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
componentBuildVersionArn (p. 66)
The Amazon Resource Name (ARN) of the component that you want to retrieve. Regex requires "/\d+
$" suffix.
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "component": {
"arn": "string",
"changeDescription": "string", "data": "string",
"dateCreated": "string", "description": "string", "encrypted": boolean,
Response Elements
"supportedOsVersions": [ "string" ], "tags": {
"string" : "string"
},
"type": "string", "version": "string"
},
"requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
component (p. 66)
The component object associated with the specified ARN.
Type: Component (p. 190) object requestId (p. 66)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 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.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
See Also
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetComponentPolicy
GetComponentPolicy
Gets a component policy.
Request Syntax
GET /GetComponentPolicy?componentArn=componentArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
componentArn (p. 69)
The Amazon Resource Name (ARN) of the component whose policy you want to retrieve.
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):component/[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+/[0-9]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "policy": "string",
"requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
policy (p. 69)
The component policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30000.
requestId (p. 69)
The request ID that uniquely identifies this request.
Type: String
Errors
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ResourceNotFoundException
At least one of the resources referenced by your request does not exist.
HTTP Status Code: 404 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetContainerRecipe
GetContainerRecipe
Retrieves a container recipe.
Request Syntax
GET /GetContainerRecipe?containerRecipeArn=containerRecipeArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
containerRecipeArn (p. 71)
The Amazon Resource Name (ARN) of the container recipe to retrieve.
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/
[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
"containerType": "string", "dateCreated": "string", "description": "string",
"dockerfileTemplateData": "string", "encrypted": boolean,
Response Elements "parentImage": "string", "platform": "string",
"workingDirectory": "string"
},
"requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
containerRecipe (p. 71)
The container recipe object that is returned.
Type: ContainerRecipe (p. 206) object requestId (p. 71)
The request ID that uniquely identifies this request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429
See Also
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.
HTTP Status Code: 400 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetContainerRecipePolicy
GetContainerRecipePolicy
Retrieves the policy for a container recipe.
Request Syntax
GET /GetContainerRecipePolicy?containerRecipeArn=containerRecipeArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
containerRecipeArn (p. 74)
The Amazon Resource Name (ARN) of the container recipe for the policy being requested.
Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):container-recipe/
[a-z0-9-_]+/[0-9]+\.[0-9]+\.[0-9]+$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "policy": "string",
"requestId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
policy (p. 74)
The container recipe policy object that is returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30000.
requestId (p. 74)
The request ID that uniquely identifies this request.
Type: String
Errors
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 268).
CallRateLimitExceededException
You have exceeded the permitted request rate for the specific operation.
HTTP Status Code: 429 ForbiddenException
You are not authorized to perform the requested operation.
HTTP Status Code: 403 InvalidRequestException
You have made a request for an action that is not supported by the service.
HTTP Status Code: 400 ResourceNotFoundException
At least one of the resources referenced by your request does not exist.
HTTP Status Code: 404 ServiceException
This exception is thrown when the service encounters an unrecoverable exception.
HTTP Status Code: 500 ServiceUnavailableException
The service is unable to process your request at this time.
HTTP Status Code: 503
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3