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
GetChangeTypeVersion
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 and DeprecationTime)
• 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 (p. 101).
The request accepts the following data in JSON format.
ChangeTypeId (p. 16)
The unique ID of the change type, in the form ct-2ty5seo8rxfsc.
Type: String Required: Yes Locale (p. 16)
The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.
Type: String Required: No Version (p. 16)
The version identifier of the change type to return.
NoteIf 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
Response Syntax
the double hyphens immediately before the get-change-type-version command. For example: aws amscm --output text -- get-change-type-version --version 1.0This 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": {
"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 (p. 17)
See Also
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:
• 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
GetRfc
GetRfc
Returns information about the specified RFC ID.
Request Syntax
{ "Locale": "string", "RfcId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
Locale (p. 19)
The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.
Type: String Required: No RfcId (p. 19)
The unique ID (UUID) of the RFC Type: String
Required: Yes
Response Syntax
{ "Rfc": {
"ActionState": { "Id": "string", "Name": "string"
},
"ActualExecutionTimeRange": { "EndTime": "string",
"StartTime": "string"
},
Response Elements
"AutomationStatus": { "Id": "string", "Name": "string"
},
"ChangeTypeId": "string", "ChangeTypeVersion": "string", "CreatedBy": "string",
"CreatedTime": "string", "Description": "string", "ExecutionOutput": "string", "ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "LastCorrespondenceTime": "string", "LastModifiedBy": "string",
"LastModifiedTime": "string", "LastSubmittedTime": "string", "Notification": {
"Email": {
"EmailRecipients": [ "string" ] }
},
"RequestedExecutionTimeRange": { "EndTime": "string",
"StartTime": "string"
},
"RestrictedExecutionTimesOverride": { "Id": "string",
"Name": "string"
},
"RfcId": "string",
"RollbackPlan": "string", "Status": {
"Id": "string", "Name": "string"
},
"StatusReason": "string", "Title": "string",
"WorstCaseScenario": "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.
Rfc (p. 19)
Information about the RFC.
Type: Rfc (p. 80) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 103).
InternalServerError
An unspecified server error occurred.
See Also
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:
• 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
GetRfcAttachment
GetRfcAttachment
Retrieve the attachment from an RFC.
Request Syntax
{ "AttachmentId": "string", "RfcId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
AttachmentId (p. 22)
The attachment identifier in an RFC attachment GET request.
Type: String Required: Yes RfcId (p. 22)
The RFC identifier in an RFC attachment GET request.
Type: String Required: Yes
Response Syntax
{ "RfcAttachment": {
"AttachmentId": "string", "Content": blob,
"ContentLengthInBytes": number, "ContentType": "string",
"CreatedBy": "string", "CreatedTime": "string", "FileName": "string", "RfcId": "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.
Errors
RfcAttachment (p. 22)
The RFC attachment in an RFC attachment GET response.
Type: RfcAttachment (p. 87) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 103).
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:
• 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
ListChangeTypeCategories
ListChangeTypeCategories
Returns the available change type category values.
Request Syntax
{ "Locale": "string", "MaxResults": number, "NextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 101).
The request accepts the following data in JSON format.
Locale (p. 24)
The locale (language) to return information in. The default is English. Note: For future use; not currently implemented.
Type: String Required: No MaxResults (p. 24)
The maximum number of items to return in one batch. Valid values are 20-100.
Type: Integer Required: No NextToken (p. 24)
If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.
Type: String Required: No
Response Syntax
{ "ChangeTypeCategories": [ "string" ], "NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
ChangeTypeCategories (p. 24)
The available change type category values.
Type: Array of strings NextToken (p. 24)
If the response contains more items than MaxResults, only MaxResults items are returned, and a NextToken pagination token is returned in the response. To retrieve the next batch of items, reissue the request and include the returned token in the NextToken parameter. When all items have been returned, the response does not contain a pagination token value.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 103).
InternalServerError
An unspecified server error occurred.
HTTP Status Code: 500 InvalidArgumentException
A specified argument is not valid.
HTTP Status Code: 400
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