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
-
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
HTTP/1.1 200
Content-type: application/json
{
"containerRecipe": {
"arn": "string",
"components": [
{
"componentArn": "string",
"parameters": [
{
"name": "string",
"value": [ "string" ]
}
]
}
],
"containerType": "string",
"dateCreated": "string",
"description": "string",
"dockerfileTemplateData": "string",
"encrypted": boolean,
"instanceConfiguration": {
"blockDeviceMappings": [
{
"deviceName": "string",
"ebs": {
"deleteOnTermination": boolean,
"encrypted": boolean,
"iops": number,
"kmsKeyId": "string",
"snapshotId": "string",
"throughput": number,
"volumeSize": number,
"volumeType": "string"
},
"noDevice": "string",
"virtualName": "string"
}
],
"image": "string"
},
"kmsKeyId": "string",
"name": "string",
"owner": "string",
"parentImage": "string",
"platform": "string",
"tags": {
"string" : "string"
},
"targetRepository": {
"repositoryName": "string",
"service": "string"
},
"version": "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
-
The container recipe object that is returned.
Type: ContainerRecipe object
- requestId
-
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.
- 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 requested an action that that the service doesn't support.
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:
