BatchGetBlueprints
Retrieves information about a list of blueprints.
Request Syntax
{
"IncludeBlueprint": boolean
,
"IncludeParameterSpec": boolean
,
"Names": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- IncludeBlueprint
-
Specifies whether or not to include the blueprint in the response.
Type: Boolean
Required: No
- IncludeParameterSpec
-
Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.
Type: Boolean
Required: No
- Names
-
A list of blueprint names.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\.\-_A-Za-z0-9]+
Required: Yes
Response Syntax
{
"Blueprints": [
{
"BlueprintLocation": "string",
"BlueprintServiceLocation": "string",
"CreatedOn": number,
"Description": "string",
"ErrorMessage": "string",
"LastActiveDefinition": {
"BlueprintLocation": "string",
"BlueprintServiceLocation": "string",
"Description": "string",
"LastModifiedOn": number,
"ParameterSpec": "string"
},
"LastModifiedOn": number,
"Name": "string",
"ParameterSpec": "string",
"Status": "string"
}
],
"MissingBlueprints": [ "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.
- Blueprints
-
Returns a list of blueprint as a
Blueprints
object.Type: Array of Blueprint objects
- MissingBlueprints
-
Returns a list of
BlueprintNames
that were not found.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\.\-_A-Za-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: