GetChangeTypeVersion
Returns information about the specified change type; optionally, you can specify a change type version identifier. By default, the most recent version of the change type is returned.
The information returned includes:
-
Execution approval requirements (
ApprovalCondition
) -
Whether execution of the change is automated or manual (
AutomationStatus
) -
Change type deprecation information (
DeprecationMessage
andDeprecationTime
) -
An estimate of the time required for execution of the change (
ExpectedExecutionDurationInMinutes
) -
The parameters that can be specified for the change (
ExecutionInputSchema
)
For more information and examples, see Understanding Change Types in the AWS Managed Services User Guide.
Request Syntax
{
"ChangeTypeId": "string
",
"Locale": "string
",
"Version": "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.
- ChangeTypeId
-
The unique ID of the change type, in the form ct-2ty5seo8rxfsc.
Type: String
Required: Yes
- Locale
-
The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.
Type: String
Required: No
- Version
-
The version identifier of the change type to return.
Note
If you use the AWS CLI and want to specify a change type version in the request, you must use extra double hyphens (--) to cause the CLI to interpret the
--version
parameter correctly (and not interpret it as a base AWS CLI option). Any base AWS CLI options and parameters (not specific to the AWS Managed Services API), such as--output
or--profile
, must appear before the double hyphen. The simplest way to do this is by putting the double hyphens immediately before theget-change-type-version
command. For example:aws amscm --output text -- get-change-type-version --version 1.0
This special treatment applies only if you specify the parameter on the command line; no special treatment is necessary if you provide parameters in JSON format.
Type: String
Required: No
Response Syntax
{
"ChangeTypeVersion": {
"AccessLevel": {
"Id": "string",
"Name": "string"
},
"ApprovalCondition": {
"AwsApproval": {
"Id": "string",
"Name": "string"
},
"CustomerApproval": {
"Id": "string",
"Name": "string"
}
},
"AutomationStatus": {
"Id": "string",
"Name": "string"
},
"ChangeTypeId": "string",
"CreatedTime": "string",
"DeprecationMessage": "string",
"DeprecationTime": "string",
"ExecutionInputSchema": "string",
"ExecutionOutputSchema": "string",
"ExpectedExecutionDurationInMinutes": number,
"Name": "string",
"Version": "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.
- ChangeTypeVersion
-
Information about the specified version of the change type.
Type: ChangeTypeVersion object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An unspecified server error occurred.
HTTP Status Code: 500
- InvalidArgumentException
-
A specified argument is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
A specified resource could not be located. Actual status code: 404
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: