# Actions The following actions are supported: + [ApproveRfc](API_ApproveRfc.md) + [CancelRfc](API_CancelRfc.md) + [CreateRfc](API_CreateRfc.md) + [CreateRfcAttachment](API_CreateRfcAttachment.md) + [CreateRfcCorrespondence](API_CreateRfcCorrespondence.md) + [GetChangeTypeVersion](API_GetChangeTypeVersion.md) + [GetRfc](API_GetRfc.md) + [GetRfcAttachment](API_GetRfcAttachment.md) + [ListChangeTypeCategories](API_ListChangeTypeCategories.md) + [ListChangeTypeClassificationSummaries](API_ListChangeTypeClassificationSummaries.md) + [ListChangeTypeItems](API_ListChangeTypeItems.md) + [ListChangeTypeOperations](API_ListChangeTypeOperations.md) + [ListChangeTypeSubcategories](API_ListChangeTypeSubcategories.md) + [ListChangeTypeVersionSummaries](API_ListChangeTypeVersionSummaries.md) + [ListRestrictedExecutionTimes](API_ListRestrictedExecutionTimes.md) + [ListRfcAttachmentSummaries](API_ListRfcAttachmentSummaries.md) + [ListRfcCorrespondences](API_ListRfcCorrespondences.md) + [ListRfcSummaries](API_ListRfcSummaries.md) + [RejectRfc](API_RejectRfc.md) + [SubmitRfc](API_SubmitRfc.md) + [UpdateRestrictedExecutionTimes](API_UpdateRestrictedExecutionTimes.md) + [UpdateRfc](API_UpdateRfc.md) # ApproveRfc Marks the specified RFC as approved. An RFC with a CT of "Execution mode: Manual" requires approval; rarely it requires customer response, either approval or rejection. If your response is explicitly required, the `Approval Status: CustomerApproval Pending` RFC status is in the RFC execution output, but you receive no other notice. You must explicitly reject or approve the RFC by running this operation or the RejectRfc operation. ## Request Syntax ``` { "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RfcId](#API_ApproveRfc_RequestSyntax) ** The unique ID (UUID) of the RFC to approve. Type: String Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ApproveRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ApproveRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ApproveRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ApproveRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ApproveRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ApproveRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ApproveRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ApproveRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ApproveRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ApproveRfc) # CancelRfc Cancels the specified RFC. ## Request Syntax ``` { "Reason": "string", "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Reason](#API_CancelRfc_RequestSyntax) ** The reason for the cancellation. If an RFC is rejected or canceled, the reason for the action appears in the `RfcReason`. Type: String Required: Yes ** [RfcId](#API_CancelRfc_RequestSyntax) ** The unique ID (UUID) of the RFC to cancel. Type: String Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/CancelRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/CancelRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/CancelRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/CancelRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/CancelRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/CancelRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/CancelRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/CancelRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/CancelRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/CancelRfc) # CreateRfc Creates a new RFC. To create a request for change, begin by calling [CreateRfc](#API_CreateRfc). After creating the basic RFC and before submitting it, you can add or update information (`Description`, `ExpectedOutcome`, `ImplementationPlan`, `RollbackPlan`, and `WorstCaseScenario`) by using the `UpdateRfc` operation ([UpdateRfc](API_UpdateRfc.md)). When all necessary information has been added, use [SubmitRfc](API_SubmitRfc.md) to activate the RFC. **Note** Although only the change type (`ChangeTypeId` and `ChangeTypeVersion`) and `Title` are required to initially create an RFC, you must provide values for these fields (either in the original [CreateRfc](#API_CreateRfc) call or by using the corresponding `UpdateRfc` ([UpdateRfc](API_UpdateRfc.md) operation) before calling [SubmitRfc](API_SubmitRfc.md): `RequestedStartTime` ([CreateRfc](#API_CreateRfc) and `RequestedEndTime`, if you want to schedule the RFC. If scheduling is unimportant, leave off these values and execution begins as soon as the RFC is approved. This is part of a feature known as ASAP, or un-scheduled RFC. `ExecutionParameters` that comply with the JSON `ExecutionInputSchema` of the change type that is associated with the RFC ([CreateRfc](#API_CreateRfc) or [UpdateRfc](API_UpdateRfc.md)) For more information and examples, see [Change Management](https://docs.aws.amazon.com/managedservices/latest/userguide/change-mgmt.html) in the *AWS Managed Services User Guide*. ## Request Syntax ``` { "ChangeTypeId": "string", "ChangeTypeVersion": "string", "Description": "string", "ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "Notification": { "Email": { "EmailRecipients": [ "string" ] } }, "RequestedEndTime": "string", "RequestedStartTime": "string", "RollbackPlan": "string", "Title": "string", "WorstCaseScenario": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [ChangeTypeId](#API_CreateRfc_RequestSyntax) ** The unique ID of the change type, in the form ct-2ty5seo8rxfsc. Type: String Required: Yes ** [ChangeTypeVersion](#API_CreateRfc_RequestSyntax) ** The version of the change type for the request; for example, "1.0". Type: String Required: Yes ** [Description](#API_CreateRfc_RequestSyntax) ** The description of the RFC. Type: String Required: No ** [ExecutionParameters](#API_CreateRfc_RequestSyntax) ** The parameters that are required to execute the RFC, submitted in JSON format. Type: String Required: No ** [ExpectedOutcome](#API_CreateRfc_RequestSyntax) ** A description of the effects of the change. Type: String Required: No ** [ImplementationPlan](#API_CreateRfc_RequestSyntax) ** The actions or steps required to implement the change (for change types that are not automated). Type: String Required: No ** [Notification](#API_CreateRfc_RequestSyntax) ** Create a notification for an existing RFC. Type: [RfcNotification](API_RfcNotification.md) object Required: No ** [RequestedEndTime](#API_CreateRfc_RequestSyntax) ** The end of the change window, expressed in ISO 8601 format. The default format is the *basic* format (`YYYYMMDDThhmmssZ`). For example, 2017/02/27 at 2:30 PM would be 20170227T143000Z. An RFC does not fail if the requested end time is exceeded. Type: String Required: No ** [RequestedStartTime](#API_CreateRfc_RequestSyntax) ** The start of the change window, expressed in ISO 8601 format. The default format is the *basic* format (`YYYYMMDDThhmmssZ`). For example, 2017/02/27 at 2:10 PM would be 20170227T141000Z. For best results, set the requested start time to at least 10 minutes after you expect to submit the automated RFC. For review required change types, you must set a start time that's at least 24 hours after you expect to submit the RFC. Alternatively, you can use the ASAP option, which causes the RFC to execute as soon as it's approved. To use the ASAP option, don't specify a start time. If the RFC doesn't pass syntax or other checks before the requested start time (if one is set), then the RFC is canceled. Type: String Required: No ** [RollbackPlan](#API_CreateRfc_RequestSyntax) ** The actions or steps required to undo the change. Type: String Required: No ** [Title](#API_CreateRfc_RequestSyntax) ** A name for the RFC; this is displayed as the subject of the RFC in the AMS console. Type: String Required: Yes ** [WorstCaseScenario](#API_CreateRfc_RequestSyntax) ** A description of the most unfavorable outcome of the change. Type: String Required: No ## Response Syntax ``` { "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. ** [RfcId](#API_CreateRfc_ResponseSyntax) ** The unique ID (UUID) of the RFC that was created. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/CreateRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/CreateRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/CreateRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/CreateRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/CreateRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/CreateRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/CreateRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/CreateRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/CreateRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/CreateRfc) # CreateRfcAttachment Create an attachment for an existing RFC. ## Request Syntax ``` { "Content": blob, "FileName": "string", "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Content](#API_CreateRfcAttachment_RequestSyntax) ** The content of the RFC attachment, which is binary data. Type: Base64-encoded binary data object Required: Yes ** [FileName](#API_CreateRfcAttachment_RequestSyntax) ** The file name of the RFC attachment. Type: String Required: Yes ** [RfcId](#API_CreateRfcAttachment_RequestSyntax) ** The RFC identifier for an RFC attachment request. Type: String Required: Yes ## Response Syntax ``` { "AttachmentId": "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. ** [AttachmentId](#API_CreateRfcAttachment_ResponseSyntax) ** The attachment identifier in an RFC attachment response. Type: String ** [RfcId](#API_CreateRfcAttachment_ResponseSyntax) ** The RFC identifier in an RFC attachment request. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 HTTP Status Code: 400 ** ResourceNotFoundException ** A specified resource could not be located. Actual status code: 404 HTTP Status Code: 400 ** ServiceQuotaExceededException ** You have exceeded your service quotas. 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/CreateRfcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/CreateRfcAttachment) # CreateRfcCorrespondence Create the correspondence for an RFC. ## Request Syntax ``` { "AttachmentIds": [ "string" ], "Content": "string", "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [AttachmentIds](#API_CreateRfcCorrespondence_RequestSyntax) ** The attachment identifiers for an RFC correspondence request. Type: Array of strings Required: No ** [Content](#API_CreateRfcCorrespondence_RequestSyntax) ** The content for an RFC correspondence request. Type: String Required: Yes ** [RfcId](#API_CreateRfcCorrespondence_RequestSyntax) ** The RFC identifier for an RFC correspondence request. Type: String Required: Yes ## Response Syntax ``` { "CorrespondenceId": "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. ** [CorrespondenceId](#API_CreateRfcCorrespondence_ResponseSyntax) ** The correspondence identifier in an RFC correspondence response. Type: String ** [RfcId](#API_CreateRfcCorrespondence_ResponseSyntax) ** The RFC identifier in an RFC correspondence response. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/CreateRfcCorrespondence) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/CreateRfcCorrespondence) # 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](https://docs.aws.amazon.com/managedservices/latest/userguide/understanding-cts.html) 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](CommonParameters.md). The request accepts the following data in JSON format. ** [ChangeTypeId](#API_GetChangeTypeVersion_RequestSyntax) ** The unique ID of the change type, in the form ct-2ty5seo8rxfsc. Type: String Required: Yes ** [Locale](#API_GetChangeTypeVersion_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [Version](#API_GetChangeTypeVersion_RequestSyntax) ** The version identifier of the change type to return. 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 the `get-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](#API_GetChangeTypeVersion_ResponseSyntax) ** Information about the specified version of the change type. Type: [ChangeTypeVersion](API_ChangeTypeVersion.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/GetChangeTypeVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/GetChangeTypeVersion) # 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](CommonParameters.md). The request accepts the following data in JSON format. ** [Locale](#API_GetRfc_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [RfcId](#API_GetRfc_RequestSyntax) ** The unique ID (UUID) of the RFC Type: String Required: Yes ## Response Syntax ``` { "Rfc": { "ActionState": { "Id": "string", "Name": "string" }, "ActualExecutionTimeRange": { "EndTime": "string", "StartTime": "string" }, "ApprovalState": { "AwsApprovalStatus": { "Id": "string", "Name": "string" }, "CustomerApprovalStatus": { "Id": "string", "Name": "string" } }, "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](#API_GetRfc_ResponseSyntax) ** Information about the RFC. Type: [Rfc](API_Rfc.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/GetRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/GetRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/GetRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/GetRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/GetRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/GetRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/GetRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/GetRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/GetRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/GetRfc) # 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](CommonParameters.md). The request accepts the following data in JSON format. ** [AttachmentId](#API_GetRfcAttachment_RequestSyntax) ** The attachment identifier in an RFC attachment GET request. Type: String Required: Yes ** [RfcId](#API_GetRfcAttachment_RequestSyntax) ** 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. ** [RfcAttachment](#API_GetRfcAttachment_ResponseSyntax) ** The RFC attachment in an RFC attachment GET response. Type: [RfcAttachment](API_RfcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/GetRfcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/GetRfcAttachment) # 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](CommonParameters.md). The request accepts the following data in JSON format. ** [Locale](#API_ListChangeTypeCategories_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListChangeTypeCategories_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeCategories_RequestSyntax) ** 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. The following data is returned in JSON format by the service. ** [ChangeTypeCategories](#API_ListChangeTypeCategories_ResponseSyntax) ** The available change type category values. Type: Array of strings ** [NextToken](#API_ListChangeTypeCategories_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeCategories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeCategories) # ListChangeTypeClassificationSummaries Returns the classifications (category, subcategory, item, and operation) for all change types that meet the specified (optional) filter criteria. ## Request Syntax ``` { "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "Locale": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListChangeTypeClassificationSummaries_RequestSyntax) ** Attribute/value pairs to narrow the results returned. Filter criteria are combined in a logical OR operation, and values that contain spaces are also combined in an OR operation. For example, a `Value` of "read-only access" matches all values that contain "read-only" OR "access". Valid filter attributes: `Category`, `Subcategory`, `Item`, `Operation`, `ChangeTypeId`. For more information and examples, see [Finding a change type, using the query option](https://docs.aws.amazon.com/managedservices/latest/userguide/ug-find-ct-ex-section.html) in the *AWS Managed Services User Guide*. Type: Array of [Filter](API_Filter.md) objects Required: No ** [Locale](#API_ListChangeTypeClassificationSummaries_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListChangeTypeClassificationSummaries_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeClassificationSummaries_RequestSyntax) ** 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 ``` { "ChangeTypeClassificationSummaries": [ { "Category": "string", "ChangeTypeId": "string", "Item": "string", "Operation": "string", "Subcategory": "string" } ], "NextToken": "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. ** [ChangeTypeClassificationSummaries](#API_ListChangeTypeClassificationSummaries_ResponseSyntax) ** The change type classifications that satisfy the filter criteria. Type: Array of [ChangeTypeClassificationSummary](API_ChangeTypeClassificationSummary.md) objects ** [NextToken](#API_ListChangeTypeClassificationSummaries_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeClassificationSummaries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeClassificationSummaries) # ListChangeTypeItems Returns the available change type item values for the specified category and subcategory values. ## Request Syntax ``` { "Category": "string", "Locale": "string", "MaxResults": number, "NextToken": "string", "Subcategory": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Category](#API_ListChangeTypeItems_RequestSyntax) ** The change type category value to return the item values for. Type: String Required: Yes ** [Locale](#API_ListChangeTypeItems_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListChangeTypeItems_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeItems_RequestSyntax) ** 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 ** [Subcategory](#API_ListChangeTypeItems_RequestSyntax) ** The change type subcategory value to return the item values for. Type: String Required: Yes ## Response Syntax ``` { "ChangeTypeItems": [ "string" ], "NextToken": "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. ** [ChangeTypeItems](#API_ListChangeTypeItems_ResponseSyntax) ** The change type item values for the specified category and subcategory values. Type: Array of strings ** [NextToken](#API_ListChangeTypeItems_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeItems) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeItems) # ListChangeTypeOperations Returns the available change type operation values for the specified category and subcategory values. ## Request Syntax ``` { "Category": "string", "Item": "string", "Locale": "string", "MaxResults": number, "NextToken": "string", "Subcategory": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Category](#API_ListChangeTypeOperations_RequestSyntax) ** The change type category value to return the operation values for. Type: String Required: Yes ** [Item](#API_ListChangeTypeOperations_RequestSyntax) ** The change type item values to return the operation values for. Type: String Required: Yes ** [Locale](#API_ListChangeTypeOperations_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListChangeTypeOperations_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeOperations_RequestSyntax) ** 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 ** [Subcategory](#API_ListChangeTypeOperations_RequestSyntax) ** The change type subcategory values to return the operation values for. Type: String Required: Yes ## Response Syntax ``` { "ChangeTypeOperationSummaries": [ { "ChangeTypeId": "string", "Operation": "string" } ], "NextToken": "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. ** [ChangeTypeOperationSummaries](#API_ListChangeTypeOperations_ResponseSyntax) ** The change type operation values for the specified category, subcategory, and item values. Type: Array of [ChangeTypeOperationSummary](API_ChangeTypeOperationSummary.md) objects ** [NextToken](#API_ListChangeTypeOperations_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeOperations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeOperations) # ListChangeTypeSubcategories Returns the available change type subcategory values for the specified category value. ## Request Syntax ``` { "Category": "string", "Locale": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Category](#API_ListChangeTypeSubcategories_RequestSyntax) ** The change type category value to return the subcategory values for. Type: String Required: Yes ** [Locale](#API_ListChangeTypeSubcategories_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListChangeTypeSubcategories_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeSubcategories_RequestSyntax) ** 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 ``` { "ChangeTypeSubcategories": [ "string" ], "NextToken": "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. ** [ChangeTypeSubcategories](#API_ListChangeTypeSubcategories_ResponseSyntax) ** The change type subcategory values for the specified category value. Type: Array of strings ** [NextToken](#API_ListChangeTypeSubcategories_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeSubcategories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeSubcategories) # ListChangeTypeVersionSummaries Returns version information (versions and deprecation times) for the specified change type. ## Request Syntax ``` { "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListChangeTypeVersionSummaries_RequestSyntax) ** The only valid filter attribute is `ChangeTypeId`, and a value is required. Type: Array of [Filter](API_Filter.md) objects Required: No ** [MaxResults](#API_ListChangeTypeVersionSummaries_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListChangeTypeVersionSummaries_RequestSyntax) ** 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 ``` { "ChangeTypeVersionSummaries": [ { "AccessLevel": { "Id": "string", "Name": "string" }, "AutomationStatus": { "Id": "string", "Name": "string" }, "ChangeTypeId": "string", "CreatedTime": "string", "DeprecationTime": "string", "Description": "string", "Name": "string", "Version": "string" } ], "NextToken": "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. ** [ChangeTypeVersionSummaries](#API_ListChangeTypeVersionSummaries_ResponseSyntax) ** The version information (versions and deprecation times) for the specified change type. Type: Array of [ChangeTypeVersionSummary](API_ChangeTypeVersionSummary.md) objects ** [NextToken](#API_ListChangeTypeVersionSummaries_ResponseSyntax) ** 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 Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListChangeTypeVersionSummaries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListChangeTypeVersionSummaries) # ListRestrictedExecutionTimes Returns the time ranges during which change execution is restricted. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [MaxResults](#API_ListRestrictedExecutionTimes_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListRestrictedExecutionTimes_RequestSyntax) ** 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 ``` { "NextToken": "string", "RestrictedExecutionTimes": [ { "TimeRange": { "EndTime": "string", "StartTime": "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. ** [NextToken](#API_ListRestrictedExecutionTimes_ResponseSyntax) ** 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 ** [RestrictedExecutionTimes](#API_ListRestrictedExecutionTimes_ResponseSyntax) ** The time ranges during which change execution is restricted. Type: Array of [RestrictedExecutionTime](API_RestrictedExecutionTime.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListRestrictedExecutionTimes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListRestrictedExecutionTimes) # ListRfcAttachmentSummaries The Request for Change (RFCs) attachments. ## Request Syntax ``` { "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "Locale": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListRfcAttachmentSummaries_RequestSyntax) ** The only valid filter attribute is `RfcId`, and a value is required. Type: Array of [Filter](API_Filter.md) objects Required: No ** [Locale](#API_ListRfcAttachmentSummaries_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListRfcAttachmentSummaries_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListRfcAttachmentSummaries_RequestSyntax) ** 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 ``` { "NextToken": "string", "RfcAttachmentSummaries": [ { "AttachmentId": "string", "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. ** [NextToken](#API_ListRfcAttachmentSummaries_ResponseSyntax) ** 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 ** [RfcAttachmentSummaries](#API_ListRfcAttachmentSummaries_ResponseSyntax) ** List a summary of the existing attachments of an RFC. Type: Array of [RfcAttachmentSummary](API_RfcAttachmentSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListRfcAttachmentSummaries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListRfcAttachmentSummaries) # ListRfcCorrespondences List the existing correspondences of an RFC. ## Request Syntax ``` { "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "Locale": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListRfcCorrespondences_RequestSyntax) ** The only valid filter attribute is `RfcId`, and a value is required. Type: Array of [Filter](API_Filter.md) objects Required: No ** [Locale](#API_ListRfcCorrespondences_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListRfcCorrespondences_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListRfcCorrespondences_RequestSyntax) ** 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 ``` { "NextToken": "string", "RfcCorrespondences": [ { "Content": "string", "CorrespondenceId": "string", "CreatedBy": "string", "CreatedTime": "string", "LinkedAttachments": [ { "AttachmentId": "string", "CreatedBy": "string", "CreatedTime": "string", "FileName": "string" } ], "RfcId": "string", "UserType": { "Id": "string", "Name": "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. ** [NextToken](#API_ListRfcCorrespondences_ResponseSyntax) ** 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 ** [RfcCorrespondences](#API_ListRfcCorrespondences_ResponseSyntax) ** The list of correspondences for an existing RFC. Type: Array of [RfcCorrespondence](API_RfcCorrespondence.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListRfcCorrespondences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListRfcCorrespondences) # ListRfcSummaries Returns summaries of Request for Change (RFCs) that meet the specified criteria. ## Request Syntax ``` { "Filters": [ { "Attribute": "string", "Condition": "string", "Value": "string", "Values": [ "string" ] } ], "Locale": "string", "MaxResults": number, "NextToken": "string", "RequestedEndTimeRange": { "EndTime": "string", "StartTime": "string" }, "RequestedStartTimeRange": { "EndTime": "string", "StartTime": "string" } } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Filters](#API_ListRfcSummaries_RequestSyntax) ** You can Filter results based on an Attribute and Value combined in a logical AND operation, or based on an Attribute, a Condition, and Values. The following are the valid filter attributes: ActualEndTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. ActualStartTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. AutomationStatusId + Valid Values: Manual, Automated + Valid Conditions: Equals + Default Condition: Equals + Notes: There are only two automation statuses. ChangeTypeId + Valid Values: Any valid change type ID; for example, ct-123h45t6uz7jl. + Valid Conditions: Equals + Default Condition: Equals + Notes: [Finding a change type, using the query option](https://docs.aws.amazon.com/managedservices/latest/userguide/ug-find-ct-ex-section.html) in the *AMS User Guide*. ChangeTypeVersion + Valid Values: Any valid change type ID; for example, 1.0. + Valid Conditions: Equals + Default Condition: Equals + Notes: [Finding a change type, using the query option](https://docs.aws.amazon.com/managedservices/latest/userguide/ug-find-ct-ex-section.html) in the *AMS User Guide*. CreatedBy + Valid Values: Any string (maximum allowed length is 2048 characters). + Valid Conditions: Contains + Default Condition: Contains + Notes: The `CreatedBy` field of the RFC contains the ARN of the user who created it. CreatedTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. LastModifiedTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. LastSubmittedTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. RequestedEndTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes:The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. RequestedStartTime + Valid Values: Any string representing an ISO8601 datetime (e.g., “20170101T000000Z”). + Valid Conditions: Before, After, Between + Default Condition: None + Notes: The Before or After condition only accepts one value in the Values field. The Between condition must have exactly two values in the Values field, where the first value should represent a date that happens before the second value. RfcStatusId + Valid Values: Canceled, Editing, Failure, InProgress, PendingApproval, Rejected, Scheduled, Success + Valid Conditions: Equals + Default Condition: Equals + Notes: Refresh the RFC list in the AMS console or run [GetRfc](API_GetRfc.md). Title + Valid Values: Any valid RFC title. + Valid Conditions: Contains + Default Condition: Contains + Notes: Regular expressions in each individual field are not supported. Case insensitive search. For more information about the filter attributes and examples, see [Finding RFCs](https://docs.aws.amazon.com/managedservices/latest/userguide/ex-rfc-find-col.html) in the *AMS User Guide*. Type: Array of [Filter](API_Filter.md) objects Required: No ** [Locale](#API_ListRfcSummaries_RequestSyntax) ** The locale (language) to return information in. The default is English. **Note:** For future use; not currently implemented. Type: String Required: No ** [MaxResults](#API_ListRfcSummaries_RequestSyntax) ** The maximum number of items to return in one batch. Valid values are 20-100. Type: Integer Required: No ** [NextToken](#API_ListRfcSummaries_RequestSyntax) ** 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 ** [RequestedEndTimeRange](#API_ListRfcSummaries_RequestSyntax) ** *This parameter has been deprecated.* The span of time during which you want the change to end. Type: [TimeRange](API_TimeRange.md) object Required: No ** [RequestedStartTimeRange](#API_ListRfcSummaries_RequestSyntax) ** *This parameter has been deprecated.* The span of time during which you want the change to start. Type: [TimeRange](API_TimeRange.md) object Required: No ## Response Syntax ``` { "NextToken": "string", "RfcSummaries": [ { "ActionState": { "Id": "string", "Name": "string" }, "ActualExecutionTimeRange": { "EndTime": "string", "StartTime": "string" }, "ApprovalState": { "AwsApprovalStatus": { "Id": "string", "Name": "string" }, "CustomerApprovalStatus": { "Id": "string", "Name": "string" } }, "AutomationStatus": { "Id": "string", "Name": "string" }, "ChangeTypeId": "string", "ChangeTypeVersion": "string", "CreatedBy": "string", "CreatedTime": "string", "LastCorrespondenceTime": "string", "LastModifiedTime": "string", "LastSubmittedTime": "string", "RequestedExecutionTimeRange": { "EndTime": "string", "StartTime": "string" }, "RfcId": "string", "Status": { "Id": "string", "Name": "string" }, "Title": "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. ** [NextToken](#API_ListRfcSummaries_ResponseSyntax) ** 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 ** [RfcSummaries](#API_ListRfcSummaries_ResponseSyntax) ** The summaries of RFCs that meet the specified criteria. Type: Array of [RfcSummary](API_RfcSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ## Examples ### Sample Request Using the CreatedBy Filter Attribute The following is an example request using the `CreatedBy` filter attribute. ``` { "Operation": "com.amazonaws.services.managedservices.cm.model#ListRfcSummaries", "Service": "com.amazonaws.services.managedservices.cm.model#AWSEnergonService", "Input": { "Filters": [ { "Attribute": "CreatedBy", "Values": [ "John", "Mary" ], "Condition": "Contains" } ] } } ``` ### Sample Response Using the CreatedBy Filter Attribute The following is an example response from the request using the `CreatedBy` filter attribute. ``` { "Output": { "__type": "com.amazonaws.services.managedservices.cm.model#ListRfcSummariesResponse", "NextToken": null, "RfcSummaries": [ { "ActionState": { "Id": "NotApplicable", "Name": "NotApplicable" }, "ActualExecutionTimeRange": { "EndTime": null, "StartTime": null }, "AutomationStatus": { "Id": "Automated", "Name": "Automated" }, "ChangeTypeId": "ct-3izj492hm8s02", "ChangeTypeVersion": "4.0", "CreatedBy": "arn:aws:sts::123456789012:assumed-role/FullAccess/John-Isengard", "CreatedTime": "20191025T232624Z", "LastCorrespondenceTime": null, "LastModifiedTime": "20191025T232624Z", "LastSubmittedTime": null, "RequestedExecutionTimeRange": { "EndTime": null, "StartTime": null }, "RfcId": "14b7029f-0a16-a83e-09d6-cd4fc9598ba9", "Status": { "Id": "Editing", "Name": "Editing" }, "Title": "test" }, { "ActionState": { "Id": "NotApplicable", "Name": "NotApplicable" }, "ActualExecutionTimeRange": { "EndTime": "20191017T184158Z", "StartTime": "20191017T184135Z" }, "AutomationStatus": { "Id": "Automated", "Name": "Automated" }, "ChangeTypeId": "ct-3izj492hm8s02", "ChangeTypeVersion": "2.0", "CreatedBy": "arn:aws:sts::111122223333:assumed-role/PowerUserAccess/Mary-Isengard", "CreatedTime": "20191017T183530Z", "LastCorrespondenceTime": null, "LastModifiedTime": "20191017T184158Z", "LastSubmittedTime": "20191017T183604Z", "RequestedExecutionTimeRange": { "EndTime": null, "StartTime": null }, "RfcId": "32b6ed80-6efd-b096-9a2b-ff273c3a52f6", "Status": { "Id": "Success", "Name": "Success" }, "Title": "testExecutionResponse" } ] } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/ListRfcSummaries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/ListRfcSummaries) # RejectRfc Marks the specified RFC as rejected. The alternate operation to `ApproveRfc`. An RFC with a CT of "Execution mode: Manual" requires approval; rarely it requires customer response, either approval or rejection. If your response is explicitly required, the `Approval Status: CustomerApproval Pending` RFC status is in the RFC execution output, but you receive no other notice. You must explicitly reject or approve the RFC by running this operation or the ApproveRfc operation. ## Request Syntax ``` { "Reason": "string", "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Reason](#API_RejectRfc_RequestSyntax) ** The reason for the rejection. If an RFC is rejected or canceled, the reason for the action appears in the `RfcReason`. Type: String Required: Yes ** [RfcId](#API_RejectRfc_RequestSyntax) ** The unique ID (UUID) of the RFC to reject. Type: String Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/RejectRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/RejectRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/RejectRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/RejectRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/RejectRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/RejectRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/RejectRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/RejectRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/RejectRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/RejectRfc) # SubmitRfc Submits the specified RFC, and optionally specifies whether to observe default execution settings. ## Request Syntax ``` { "RestrictedExecutionTimesOverrideId": "string", "RfcId": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RestrictedExecutionTimesOverrideId](#API_SubmitRfc_RequestSyntax) ** The ID of a value that indicates how the change should observe default execution settings. Possible values: `NoOverrides` \$1 `OverrideRestrictedTimeRanges`. The default is `NoOverrides`. Type: String Required: No ** [RfcId](#API_SubmitRfc_RequestSyntax) ** The unique ID (UUID) of the RFC to submit. Type: String Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcScheduleException ** The specified schedule is not valid. Actual status code: 409 HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/SubmitRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/SubmitRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/SubmitRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/SubmitRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/SubmitRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/SubmitRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/SubmitRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/SubmitRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/SubmitRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/SubmitRfc) # UpdateRestrictedExecutionTimes Replaces the existing times when change execution is restricted. ## Request Syntax ``` { "RestrictedExecutionTimes": [ { "TimeRange": { "EndTime": "string", "StartTime": "string" } } ] } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [RestrictedExecutionTimes](#API_UpdateRestrictedExecutionTimes_RequestSyntax) ** The new restricted time ranges. Type: Array of [RestrictedExecutionTime](API_RestrictedExecutionTime.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/UpdateRestrictedExecutionTimes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/UpdateRestrictedExecutionTimes) # UpdateRfc Updates settings for the specified RFC ID. Updates non-null values. ## Request Syntax ``` { "Description": "string", "ExecutionParameters": "string", "ExpectedOutcome": "string", "ImplementationPlan": "string", "Notification": { "Email": { "EmailRecipients": [ "string" ] } }, "RequestedEndTime": "string", "RequestedStartTime": "string", "RfcId": "string", "RollbackPlan": "string", "Title": "string", "WorstCaseScenario": "string" } ``` ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). The request accepts the following data in JSON format. ** [Description](#API_UpdateRfc_RequestSyntax) ** The new description of the RFC. Type: String Required: No ** [ExecutionParameters](#API_UpdateRfc_RequestSyntax) ** The new parameters that are required to execute the RFC, submitted in JSON format. Type: String Required: No ** [ExpectedOutcome](#API_UpdateRfc_RequestSyntax) ** A new description of the effects of the change. Type: String Required: No ** [ImplementationPlan](#API_UpdateRfc_RequestSyntax) ** The new actions or steps required to implement the change (for change types that are not automated). Type: String Required: No ** [Notification](#API_UpdateRfc_RequestSyntax) ** Notice that an RFC has been updated. Type: [RfcNotification](API_RfcNotification.md) object Required: No ** [RequestedEndTime](#API_UpdateRfc_RequestSyntax) ** The new end of the change window, expressed in ISO 8601 format. The default format is the *basic* format (`YYYYMMDDThhmmssZ`). For example, 2017/02/27 at 2:30 PM would be 20170227T143000Z. An RFC does not fail if the requested end time is exceeded. Type: String Required: No ** [RequestedStartTime](#API_UpdateRfc_RequestSyntax) ** The new start of the change window, expressed in ISO 8601 format. The default format is the *basic* format (`YYYYMMDDThhmmssZ`). For example, 2017/02/27 at 2:10 PM would be 20170227T141000Z. For best results, set the requested start time to at least 10 minutes past the time that you expect to submit the RFC. For review required change types, you must set a start time that's at least 24 hours after you expect to submit the RFC. Alternatively, you can use the ASAP option, which causes the RFC to execute as soon as it's approved. To use the ASAP option, don't specify a start time. If the RFC doesn't pass syntax or other checks before the requested start time (if set), then the RFC is canceled. Type: String Required: No ** [RfcId](#API_UpdateRfc_RequestSyntax) ** The unique ID (UUID) of the RFC. Type: String Required: Yes ** [RollbackPlan](#API_UpdateRfc_RequestSyntax) ** The new actions or steps required to undo the change. Type: String Required: No ** [Title](#API_UpdateRfc_RequestSyntax) ** A new name for the RFC; this is displayed as the subject of the RFC in the AMS console. Type: String Required: No ** [WorstCaseScenario](#API_UpdateRfc_RequestSyntax) ** A new description of the most unfavorable outcome of the change. Type: String Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An unspecified server error occurred. HTTP Status Code: 500 ** InvalidArgumentException ** A specified argument is not valid. HTTP Status Code: 400 ** InvalidRfcStateException ** The RFC is not in a state that allows the requested operation. Actual status code: 409 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 V2](https://docs.aws.amazon.com/goto/cli2/amscm-2020-05-21/UpdateRfc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/amscm-2020-05-21/UpdateRfc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/amscm-2020-05-21/UpdateRfc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/amscm-2020-05-21/UpdateRfc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/amscm-2020-05-21/UpdateRfc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/amscm-2020-05-21/UpdateRfc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/amscm-2020-05-21/UpdateRfc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/amscm-2020-05-21/UpdateRfc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/amscm-2020-05-21/UpdateRfc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/amscm-2020-05-21/UpdateRfc)