# Actions The following actions are supported: + [AddAttachmentsToSet](API_AddAttachmentsToSet.md) + [AddCommunicationToCase](API_AddCommunicationToCase.md) + [CreateCase](API_CreateCase.md) + [DescribeAttachment](API_DescribeAttachment.md) + [DescribeCases](API_DescribeCases.md) + [DescribeCommunications](API_DescribeCommunications.md) + [DescribeCreateCaseOptions](API_DescribeCreateCaseOptions.md) + [DescribeServices](API_DescribeServices.md) + [DescribeSeverityLevels](API_DescribeSeverityLevels.md) + [DescribeSupportedLanguages](API_DescribeSupportedLanguages.md) + [DescribeTrustedAdvisorCheckRefreshStatuses](API_DescribeTrustedAdvisorCheckRefreshStatuses.md) + [DescribeTrustedAdvisorCheckResult](API_DescribeTrustedAdvisorCheckResult.md) + [DescribeTrustedAdvisorChecks](API_DescribeTrustedAdvisorChecks.md) + [DescribeTrustedAdvisorCheckSummaries](API_DescribeTrustedAdvisorCheckSummaries.md) + [RefreshTrustedAdvisorCheck](API_RefreshTrustedAdvisorCheck.md) + [ResolveCase](API_ResolveCase.md) # AddAttachmentsToSet Adds one or more attachments to an attachment set. An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The `expiryTime` returned in the response is when the set expires. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "attachments": [ { "data": blob, "fileName": "string" } ], "attachmentSetId": "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. ** [attachments](#API_AddAttachmentsToSet_RequestSyntax) ** One or more attachments to add to the set. You can add up to three attachments per set. The size limit is 5 MB per attachment. In the `Attachment` object, use the `data` parameter to specify the contents of the attachment file. In the previous request syntax, the value for `data` appear as `blob`, which is represented as a base64-encoded string. The value for `fileName` is the name of the attachment, such as `troubleshoot-screenshot.png`. Type: Array of [Attachment](API_Attachment.md) objects ** [attachmentSetId](#API_AddAttachmentsToSet_RequestSyntax) ** The ID of the attachment set. If an `attachmentSetId` is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an `attachmentSetId` is specified, the attachments are added to the specified set, if it exists. Type: String ## Response Syntax ``` { "attachmentSetId": "string", "expiryTime": "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. ** [attachmentSetId](#API_AddAttachmentsToSet_ResponseSyntax) ** The ID of the attachment set. If an `attachmentSetId` was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an `attachmentSetId` was specified, the attachments are added to the specified set, if it exists. Type: String ** [expiryTime](#API_AddAttachmentsToSet_ResponseSyntax) ** The time and date when the attachment set expires. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AttachmentLimitExceeded ** The limit for the number of attachment sets created in a short period of time has been exceeded. ** message ** The limit for the number of attachment sets created in a short period of time has been exceeded. HTTP Status Code: 400 ** AttachmentSetExpired ** The expiration time of the attachment set has passed. The set expires 1 hour after it is created. ** message ** The expiration time of the attachment set has passed. The set expires one hour after it is created. HTTP Status Code: 400 ** AttachmentSetIdNotFound ** An attachment set with the specified ID could not be found. ** message ** An attachment set with the specified ID could not be found. HTTP Status Code: 400 ** AttachmentSetSizeLimitExceeded ** A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment. ** message ** A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddAttachmentsToSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/AddAttachmentsToSet) # AddCommunicationToCase Adds additional customer communication to an Support case. Use the `caseId` parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the `ccEmailAddresses` parameter. The `communicationBody` value contains the text of the communication. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "attachmentSetId": "string", "caseId": "string", "ccEmailAddresses": [ "string" ], "communicationBody": "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. ** [attachmentSetId](#API_AddCommunicationToCase_RequestSyntax) ** The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling [AddAttachmentsToSet](API_AddAttachmentsToSet.md) Type: String ** [caseId](#API_AddCommunicationToCase_RequestSyntax) ** The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-*12345678910-exen-2025-c4c1d2bf33c5cf47* Type: String ** [ccEmailAddresses](#API_AddCommunicationToCase_RequestSyntax) ** The email addresses in the CC line of an email to be added to the support case. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [communicationBody](#API_AddCommunicationToCase_RequestSyntax) ** The body of an email communication to add to the support case. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. ## Response Syntax ``` { "result": boolean } ``` ## 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. ** [result](#API_AddCommunicationToCase_ResponseSyntax) ** True if [AddCommunicationToCase](#API_AddCommunicationToCase) succeeds. Otherwise, returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AttachmentSetExpired ** The expiration time of the attachment set has passed. The set expires 1 hour after it is created. ** message ** The expiration time of the attachment set has passed. The set expires one hour after it is created. HTTP Status Code: 400 ** AttachmentSetIdNotFound ** An attachment set with the specified ID could not be found. ** message ** An attachment set with the specified ID could not be found. HTTP Status Code: 400 ** CaseIdNotFound ** The requested `caseId` couldn't be located. ** message ** The requested `CaseId` could not be located. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/AddCommunicationToCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/AddCommunicationToCase) # CreateCase Creates a case in the Support Center. This operation is similar to how you create a case in the Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. The Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways: + Submit a request from the Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. + Use the Service Quotas [RequestServiceQuotaIncrease](https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_RequestServiceQuotaIncrease.html) operation. A successful `CreateCase` request returns an Support case number. You can use the [DescribeCases](API_DescribeCases.md) operation and specify the case number to get existing Support cases. After you create a case, use the [AddCommunicationToCase](API_AddCommunicationToCase.md) operation to add additional communication or attachments to an existing case. The `caseId` is separate from the `displayId` that appears in the [AWS Support Center](https://console.aws.amazon.com/support). Use the [DescribeCases](API_DescribeCases.md) operation to get the `displayId`. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "attachmentSetId": "string", "categoryCode": "string", "ccEmailAddresses": [ "string" ], "communicationBody": "string", "issueType": "string", "language": "string", "serviceCode": "string", "severityCode": "string", "subject": "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. ** [attachmentSetId](#API_CreateCase_RequestSyntax) ** The ID of a set of one or more attachments for the case. Create the set by using the [AddAttachmentsToSet](API_AddAttachmentsToSet.md) operation. Type: String ** [categoryCode](#API_CreateCase_RequestSyntax) ** The category of problem for the support case. You also use the [DescribeServices](API_DescribeServices.md) operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String ** [ccEmailAddresses](#API_CreateCase_RequestSyntax) ** A list of email addresses that AWS Support copies on case correspondence. AWS Support identifies the account that creates the case when you specify your AWS credentials in an HTTP POST method or use the [AWS SDKs](http://aws.amazon.com/tools/). Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [communicationBody](#API_CreateCase_RequestSyntax) ** The communication body text that describes the issue. This text appears in the **Description** field on the AWS Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. Type: String Length Constraints: Minimum length of 1. Maximum length of 8000. ** [issueType](#API_CreateCase_RequestSyntax) ** The type of issue for the case. You can specify `customer-service` or `technical`. If you don't specify a value, the default is `technical`. Type: String ** [language](#API_CreateCase_RequestSyntax) ** The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language. Type: String ** [serviceCode](#API_CreateCase_RequestSyntax) ** The code for the AWS service. You can use the [DescribeServices](API_DescribeServices.md) operation to get the possible `serviceCode` values. Type: String ** [severityCode](#API_CreateCase_RequestSyntax) ** A value that indicates the urgency of the case. This value determines the response time according to your service level agreement with AWS Support. You can use the [DescribeSeverityLevels](API_DescribeSeverityLevels.md) operation to get the possible values for `severityCode`. For more information, see [SeverityLevel](API_SeverityLevel.md) and [Choosing a Severity](https://docs.aws.amazon.com/awssupport/latest/user/getting-started.html#choosing-severity) in the * AWS Support User Guide*. The availability of severity levels depends on the support plan for the AWS account. Type: String ** [subject](#API_CreateCase_RequestSyntax) ** The title of the support case. The title appears in the **Subject** field on the AWS Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. Type: String ## Response Syntax ``` { "caseId": "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. ** [caseId](#API_CreateCase_ResponseSyntax) ** The support case ID requested or returned in the call. The case ID is an alphanumeric string in the following format: case-*12345678910-exen-2025-c4c1d2bf33c5cf47* Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AttachmentSetExpired ** The expiration time of the attachment set has passed. The set expires 1 hour after it is created. ** message ** The expiration time of the attachment set has passed. The set expires one hour after it is created. HTTP Status Code: 400 ** AttachmentSetIdNotFound ** An attachment set with the specified ID could not be found. ** message ** An attachment set with the specified ID could not be found. HTTP Status Code: 400 ** CaseCreationLimitExceeded ** The case creation limit for the account has been exceeded. ** message ** An error message that indicates that you have exceeded the number of cases you can have open. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/CreateCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/CreateCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/CreateCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/CreateCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/CreateCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/CreateCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/CreateCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/CreateCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/CreateCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/CreateCase) # DescribeAttachment Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the [AttachmentDetails](API_AttachmentDetails.md) objects that are returned by the [DescribeCommunications](API_DescribeCommunications.md) operation. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "attachmentId": "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_DescribeAttachment_RequestSyntax) ** The ID of the attachment to return. Attachment IDs are returned by the [DescribeCommunications](API_DescribeCommunications.md) operation. Type: String ## Response Syntax ``` { "attachment": { "data": blob, "fileName": "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. ** [attachment](#API_DescribeAttachment_ResponseSyntax) ** This object includes the attachment content and file name. In the previous response syntax, the value for the `data` parameter appears as `blob`, which is represented as a base64-encoded string. The value for `fileName` is the name of the attachment, such as `troubleshoot-screenshot.png`. Type: [Attachment](API_Attachment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AttachmentIdNotFound ** An attachment with the specified ID could not be found. ** message ** An attachment with the specified ID could not be found. HTTP Status Code: 400 ** DescribeAttachmentLimitExceeded ** The limit for the number of [DescribeAttachment](#API_DescribeAttachment) requests in a short period of time has been exceeded. ** message ** The limit for the number of [DescribeAttachment](#API_DescribeAttachment) requests in a short period of time has been exceeded. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/DescribeAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeAttachment) # DescribeCases Returns a list of cases that you specify by passing one or more case IDs. You can use the `afterTime` and `beforeTime` parameters to filter the cases by date. You can set values for the `includeResolvedCases` and `includeCommunications` parameters to specify how much information to return. The response returns the following in JSON format: + One or more [CaseDetails](https://docs.aws.amazon.com/awssupport/latest/APIReference/API_CaseDetails.html) data types. + One or more `nextToken` values, which specify where to paginate the returned records represented by the `CaseDetails` objects. Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request might return an error. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "afterTime": "string", "beforeTime": "string", "caseIdList": [ "string" ], "displayId": "string", "includeCommunications": boolean, "includeResolvedCases": boolean, "language": "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. ** [afterTime](#API_DescribeCases_RequestSyntax) ** The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String ** [beforeTime](#API_DescribeCases_RequestSyntax) ** The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String ** [caseIdList](#API_DescribeCases_RequestSyntax) ** A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. ** [displayId](#API_DescribeCases_RequestSyntax) ** The ID displayed for a case in the AWS Support Center user interface. Type: String ** [includeCommunications](#API_DescribeCases_RequestSyntax) ** Specifies whether to include communications in the `DescribeCases` response. By default, communications are included. Type: Boolean ** [includeResolvedCases](#API_DescribeCases_RequestSyntax) ** Specifies whether to include resolved support cases in the `DescribeCases` response. By default, resolved cases aren't included. Type: Boolean ** [language](#API_DescribeCases_RequestSyntax) ** The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language. Type: String ** [maxResults](#API_DescribeCases_RequestSyntax) ** The maximum number of results to return before paginating. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. ** [nextToken](#API_DescribeCases_RequestSyntax) ** A resumption point for pagination. Type: String ## Response Syntax ``` { "cases": [ { "caseId": "string", "categoryCode": "string", "ccEmailAddresses": [ "string" ], "displayId": "string", "language": "string", "recentCommunications": { "communications": [ { "attachmentSet": [ { "attachmentId": "string", "fileName": "string" } ], "body": "string", "caseId": "string", "submittedBy": "string", "timeCreated": "string" } ], "nextToken": "string" }, "serviceCode": "string", "severityCode": "string", "status": "string", "subject": "string", "submittedBy": "string", "timeCreated": "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. ** [cases](#API_DescribeCases_ResponseSyntax) ** The details for the cases that match the request. Type: Array of [CaseDetails](API_CaseDetails.md) objects ** [nextToken](#API_DescribeCases_ResponseSyntax) ** A resumption point for pagination. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** CaseIdNotFound ** The requested `caseId` couldn't be located. ** message ** The requested `CaseId` could not be located. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/DescribeCases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeCases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeCases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeCases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeCases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeCases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeCases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeCases) # DescribeCommunications Returns communications and attachments for one or more support cases. Use the `afterTime` and `beforeTime` parameters to filter by date. You can use the `caseId` parameter to restrict the results to a specific case. Case data is available for 24 months after creation. If a case was created more than 24 months ago, a request for data might cause an error. You can use the `maxResults` and `nextToken` parameters to control the pagination of the results. Set `maxResults` to the number of cases that you want to display on each page, and use `nextToken` to specify the resumption of pagination. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "afterTime": "string", "beforeTime": "string", "caseId": "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. ** [afterTime](#API_DescribeCommunications_RequestSyntax) ** The start date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String ** [beforeTime](#API_DescribeCommunications_RequestSyntax) ** The end date for a filtered date search on support case communications. Case communications are available for 24 months after creation. Type: String ** [caseId](#API_DescribeCommunications_RequestSyntax) ** The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-*12345678910-exen-2025-c4c1d2bf33c5cf47* Type: String ** [maxResults](#API_DescribeCommunications_RequestSyntax) ** The maximum number of results to return before paginating. Type: Integer Valid Range: Minimum value of 10. Maximum value of 100. ** [nextToken](#API_DescribeCommunications_RequestSyntax) ** A resumption point for pagination. Type: String ## Response Syntax ``` { "communications": [ { "attachmentSet": [ { "attachmentId": "string", "fileName": "string" } ], "body": "string", "caseId": "string", "submittedBy": "string", "timeCreated": "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. ** [communications](#API_DescribeCommunications_ResponseSyntax) ** The communications for the case. Type: Array of [Communication](API_Communication.md) objects ** [nextToken](#API_DescribeCommunications_ResponseSyntax) ** A resumption point for pagination. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** CaseIdNotFound ** The requested `caseId` couldn't be located. ** message ** The requested `CaseId` could not be located. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/DescribeCommunications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeCommunications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeCommunications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeCommunications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCommunications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeCommunications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeCommunications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeCommunications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCommunications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeCommunications) # DescribeCreateCaseOptions Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the `language` `categoryCode`, `issueType` and `serviceCode` used to retrieve the CreateCaseOptions. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "categoryCode": "string", "issueType": "string", "language": "string", "serviceCode": "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. ** [categoryCode](#API_DescribeCreateCaseOptions_RequestSyntax) ** The category of problem for the support case. You also use the [DescribeServices](API_DescribeServices.md) operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String ** [issueType](#API_DescribeCreateCaseOptions_RequestSyntax) ** The type of issue for the case. You can specify `customer-service` or `technical`. If you don't specify a value, the default is `technical`. Type: String ** [language](#API_DescribeCreateCaseOptions_RequestSyntax) ** The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language. Type: String ** [serviceCode](#API_DescribeCreateCaseOptions_RequestSyntax) ** The code for the AWS service. You can use the [DescribeServices](API_DescribeServices.md) operation to get the possible `serviceCode` values. Type: String ## Response Syntax ``` { "communicationTypes": [ { "datesWithoutSupport": [ { "endDateTime": "string", "startDateTime": "string" } ], "supportedHours": [ { "endTime": "string", "startTime": "string" } ], "type": "string" } ], "languageAvailability": "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. ** [communicationTypes](#API_DescribeCreateCaseOptions_ResponseSyntax) ** A JSON-formatted array that contains the available communication type options, along with the available support timeframes for the given inputs. Type: Array of [CommunicationTypeOptions](API_CommunicationTypeOptions.md) objects Array Members: Minimum number of 1 item. Maximum number of 100 items. ** [languageAvailability](#API_DescribeCreateCaseOptions_ResponseSyntax) ** Language availability can be any of the following: + available + best\$1effort + unavailable Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeCreateCaseOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeCreateCaseOptions) # DescribeServices Returns the current list of AWS services and a list of service categories for each service. You then use service names and categories in your [CreateCase](API_CreateCase.md) requests. Each AWS service has its own set of categories. The service codes and category codes correspond to the values that appear in the **Service** and **Category** lists on the Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. The values in those fields don't necessarily match the service codes and categories returned by the `DescribeServices` operation. Always use the service codes and categories that the `DescribeServices` operation returns, so that you have the most recent set of service and category codes. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "language": "string", "serviceCodeList": [ "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. ** [language](#API_DescribeServices_RequestSyntax) ** The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language. Type: String ** [serviceCodeList](#API_DescribeServices_RequestSyntax) ** A JSON-formatted list of service codes available for AWS services. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Response Syntax ``` { "services": [ { "categories": [ { "code": "string", "name": "string" } ], "code": "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. ** [services](#API_DescribeServices_ResponseSyntax) ** A JSON-formatted list of AWS services. Type: Array of [Service](API_Service.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/DescribeServices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeServices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeServices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeServices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeServices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeServices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeServices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeServices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeServices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeServices) # DescribeSeverityLevels Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the [CaseDetails](API_CaseDetails.md) data type that you include for a [CreateCase](API_CreateCase.md) request. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "language": "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. ** [language](#API_DescribeSeverityLevels_RequestSyntax) ** The language in which AWS Support handles the case. AWS Support currently supports Chinese (“zh”), English ("en"), Japanese ("ja") , Chinese ("zh"), Spanish ("es"), Portuguese ("pt"), French ("fr"), Korean (“ko”), and Turkish ("tr"). You must specify the ISO 639-1 code for the `language` parameter if you want support in that language. Type: String ## Response Syntax ``` { "severityLevels": [ { "code": "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. ** [severityLevels](#API_DescribeSeverityLevels_ResponseSyntax) ** The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS. Type: Array of [SeverityLevel](API_SeverityLevel.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeSeverityLevels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeSeverityLevels) # DescribeSupportedLanguages Returns a list of supported languages for a specified `categoryCode`, `issueType` and `serviceCode`. The returned supported languages will include a ISO 639-1 code for the `language`, and the language display name. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "categoryCode": "string", "issueType": "string", "serviceCode": "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. ** [categoryCode](#API_DescribeSupportedLanguages_RequestSyntax) ** The category of problem for the support case. You also use the [DescribeServices](API_DescribeServices.md) operation to get the category code for a service. Each AWS service defines its own set of category codes. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ** [issueType](#API_DescribeSupportedLanguages_RequestSyntax) ** The type of issue for the case. You can specify `customer-service` or `technical`. Type: String Length Constraints: Minimum length of 9. Maximum length of 22. ** [serviceCode](#API_DescribeSupportedLanguages_RequestSyntax) ** The code for the AWS service. You can use the [DescribeServices](API_DescribeServices.md) operation to get the possible `serviceCode` values. Type: String Length Constraints: Minimum length of 0. Maximum length of 100. ## Response Syntax ``` { "supportedLanguages": [ { "code": "string", "display": "string", "language": "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. ** [supportedLanguages](#API_DescribeSupportedLanguages_ResponseSyntax) ** A JSON-formatted array that contains the available ISO 639-1 language codes. Type: Array of [SupportedLanguage](API_SupportedLanguage.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeSupportedLanguages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeSupportedLanguages) # DescribeTrustedAdvisorCheckRefreshStatuses Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the [DescribeTrustedAdvisorChecks](API_DescribeTrustedAdvisorChecks.md) operation. Some checks are refreshed automatically, and you can't return their refresh statuses by using the `DescribeTrustedAdvisorCheckRefreshStatuses` operation. If you call this operation for these checks, you might see an `InvalidParameterValue` error. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see [About the AWS Support API](https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) in the * AWS Support User Guide*. ## Request Syntax ``` { "checkIds": [ "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. ** [checkIds](#API_DescribeTrustedAdvisorCheckRefreshStatuses_RequestSyntax) ** The IDs of the Trusted Advisor checks to get the status. If you specify the check ID of a check that is automatically refreshed, you might see an `InvalidParameterValue` error. Type: Array of strings ## Response Syntax ``` { "statuses": [ { "checkId": "string", "millisUntilNextRefreshable": number, "status": "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. ** [statuses](#API_DescribeTrustedAdvisorCheckRefreshStatuses_ResponseSyntax) ** The refresh status of the specified Trusted Advisor checks. Type: Array of [TrustedAdvisorCheckRefreshStatus](API_TrustedAdvisorCheckRefreshStatus.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeTrustedAdvisorCheckRefreshStatuses) # DescribeTrustedAdvisorCheckResult Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the [DescribeTrustedAdvisorChecks](API_DescribeTrustedAdvisorChecks.md) operation. The response contains a [TrustedAdvisorCheckResult](API_TrustedAdvisorCheckResult.md) object, which contains these three objects: + [TrustedAdvisorCategorySpecificSummary](API_TrustedAdvisorCategorySpecificSummary.md) + [TrustedAdvisorResourceDetail](API_TrustedAdvisorResourceDetail.md) + [TrustedAdvisorResourcesSummary](API_TrustedAdvisorResourcesSummary.md) In addition, the response contains these fields: + **status** - The alert status of the check can be `ok` (green), `warning` (yellow), `error` (red), or `not_available`. + **timestamp** - The time of the last refresh of the check. + **checkId** - The unique identifier for the check. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see [About the AWS Support API](https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) in the * AWS Support User Guide*. ## Request Syntax ``` { "checkId": "string", "language": "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. ** [checkId](#API_DescribeTrustedAdvisorCheckResult_RequestSyntax) ** The unique identifier for the Trusted Advisor check. Type: String ** [language](#API_DescribeTrustedAdvisorCheckResult_RequestSyntax) ** The ISO 639-1 code for the language that you want your check results to appear in. The Support API currently supports the following languages for Trusted Advisor: + Chinese, Simplified - `zh` + Chinese, Traditional - `zh_TW` + English - `en` + French - `fr` + German - `de` + Indonesian - `id` + Italian - `it` + Japanese - `ja` + Korean - `ko` + Portuguese, Brazilian - `pt_BR` + Spanish - `es` Type: String ## Response Syntax ``` { "result": { "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "checkId": "string", "flaggedResources": [ { "isSuppressed": boolean, "metadata": [ "string" ], "region": "string", "resourceId": "string", "status": "string" } ], "resourcesSummary": { "resourcesFlagged": number, "resourcesIgnored": number, "resourcesProcessed": number, "resourcesSuppressed": number }, "status": "string", "timestamp": "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. ** [result](#API_DescribeTrustedAdvisorCheckResult_ResponseSyntax) ** The detailed results of the Trusted Advisor check. Type: [TrustedAdvisorCheckResult](API_TrustedAdvisorCheckResult.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeTrustedAdvisorCheckResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeTrustedAdvisorCheckResult) # DescribeTrustedAdvisorChecks Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The response contains a [TrustedAdvisorCheckDescription](API_TrustedAdvisorCheckDescription.md) object for each check. You must set the AWS Region to us-east-1. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check. To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see [About the AWS Support API](https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) in the * AWS Support User Guide*. ## Request Syntax ``` { "language": "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. ** [language](#API_DescribeTrustedAdvisorChecks_RequestSyntax) ** The ISO 639-1 code for the language that you want your checks to appear in. The Support API currently supports the following languages for Trusted Advisor: + Chinese, Simplified - `zh` + Chinese, Traditional - `zh_TW` + English - `en` + French - `fr` + German - `de` + Indonesian - `id` + Italian - `it` + Japanese - `ja` + Korean - `ko` + Portuguese, Brazilian - `pt_BR` + Spanish - `es` Type: String ## Response Syntax ``` { "checks": [ { "category": "string", "description": "string", "id": "string", "metadata": [ "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. ** [checks](#API_DescribeTrustedAdvisorChecks_ResponseSyntax) ** Information about all available Trusted Advisor checks. Type: Array of [TrustedAdvisorCheckDescription](API_TrustedAdvisorCheckDescription.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeTrustedAdvisorChecks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeTrustedAdvisorChecks) # DescribeTrustedAdvisorCheckSummaries Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the [DescribeTrustedAdvisorChecks](API_DescribeTrustedAdvisorChecks.md) operation. The response contains an array of [TrustedAdvisorCheckSummary](API_TrustedAdvisorCheckSummary.md) objects. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see [About the AWS Support API](https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) in the * AWS Support User Guide*. **Understanding the Trusted Advisor Resources processed value** The **Resources processed** value, `resourcesProcessed`, usually shows both flagged resources (those with warnings or errors) and resources in good standing (ok status resources). However, some checks report flagged resources only. To understand what a specific check reports, review the detailed check information in the [AWS Trusted Advisor check reference](https://docs.aws.amazon.com/awssupport/latest/user/trusted-advisor-check-reference.html). If you see a **Green** criterion listed in the **Alert criteria**, then the check reports all resources. If there's no **Green** criterion listed in the **Alert criteria**, then the check reports only flagged resources. For example, the [Amazon EC2 Reserved Instance optimization check (cX3c2R1chu)](https://docs.aws.amazon.com/awssupport/latest/user/cost-optimization-checks.html#amazon-ec2-reserved-instances-optimization) doesn't list a **Green** criterion in the **Alert criteria**. So, this check only reports flagged resources. ## Request Syntax ``` { "checkIds": [ "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. ** [checkIds](#API_DescribeTrustedAdvisorCheckSummaries_RequestSyntax) ** The IDs of the Trusted Advisor checks. Type: Array of strings ## Response Syntax ``` { "summaries": [ { "categorySpecificSummary": { "costOptimizing": { "estimatedMonthlySavings": number, "estimatedPercentMonthlySavings": number } }, "checkId": "string", "hasFlaggedResources": boolean, "resourcesSummary": { "resourcesFlagged": number, "resourcesIgnored": number, "resourcesProcessed": number, "resourcesSuppressed": number }, "status": "string", "timestamp": "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. ** [summaries](#API_DescribeTrustedAdvisorCheckSummaries_ResponseSyntax) ** The summary information for the requested Trusted Advisor checks. Type: Array of [TrustedAdvisorCheckSummary](API_TrustedAdvisorCheckSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ** ThrottlingException ** You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations. 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/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/DescribeTrustedAdvisorCheckSummaries) # RefreshTrustedAdvisorCheck Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the [DescribeTrustedAdvisorChecks](API_DescribeTrustedAdvisorChecks.md) operation. Some checks are refreshed automatically. If you call the `RefreshTrustedAdvisorCheck` operation to refresh them, you might see the `InvalidParameterValue` error. The response contains a [TrustedAdvisorCheckRefreshStatus](API_TrustedAdvisorCheckRefreshStatus.md) object. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). To call the AWS Trusted Advisor operations in the AWS Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see [About the AWS Support API](https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint) in the * AWS Support User Guide*. ## Request Syntax ``` { "checkId": "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. ** [checkId](#API_RefreshTrustedAdvisorCheck_RequestSyntax) ** The unique identifier for the Trusted Advisor check to refresh. Specifying the check ID of a check that is automatically refreshed causes an `InvalidParameterValue` error. Type: String ## Response Syntax ``` { "status": { "checkId": "string", "millisUntilNextRefreshable": number, "status": "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. ** [status](#API_RefreshTrustedAdvisorCheck_ResponseSyntax) ** The current refresh status for a check, including the amount of time until the check is eligible for refresh. Type: [TrustedAdvisorCheckRefreshStatus](API_TrustedAdvisorCheckRefreshStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/RefreshTrustedAdvisorCheck) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/RefreshTrustedAdvisorCheck) # ResolveCase Resolves a support case. This operation takes a `caseId` and returns the initial and final state of the case. **Note** You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API. If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/). ## Request Syntax ``` { "caseId": "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. ** [caseId](#API_ResolveCase_RequestSyntax) ** The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-*12345678910-exen-2025-c4c1d2bf33c5cf47* Type: String ## Response Syntax ``` { "finalCaseStatus": "string", "initialCaseStatus": "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. ** [finalCaseStatus](#API_ResolveCase_ResponseSyntax) ** The status of the case after the [ResolveCase](#API_ResolveCase) request was processed. Type: String ** [initialCaseStatus](#API_ResolveCase_ResponseSyntax) ** The status of the case when the [ResolveCase](#API_ResolveCase) request was sent. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** CaseIdNotFound ** The requested `caseId` couldn't be located. ** message ** The requested `CaseId` could not be located. HTTP Status Code: 400 ** InternalServerError ** An internal server error occurred. ** message ** An internal server error occurred. HTTP Status Code: 500 ## 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/support-2013-04-15/ResolveCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/support-2013-04-15/ResolveCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/support-2013-04-15/ResolveCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/support-2013-04-15/ResolveCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/support-2013-04-15/ResolveCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/support-2013-04-15/ResolveCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/support-2013-04-15/ResolveCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/support-2013-04-15/ResolveCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/support-2013-04-15/ResolveCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/support-2013-04-15/ResolveCase)