Amazon Web Services, Inc.

AWS Support

Amazon Web Services Support The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Web Services Support
The Amazon Web Services Support API Reference is intended for programmers who need detailed
information about the Amazon Web Services Support operations and data types. You can use the API to manage
your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return
results in JSON format.

You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan to use the Amazon Web Services Support
API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Amazon Web Services Support API with a Business, Enterprise On-Ramp, or Enterprise Support plan.

If you call the Amazon Web Services Support API from an account that doesn't have an
Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan, the
SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web Services Support .

You can also use the Amazon Web Services Support API to access features for Trusted Advisor . You can return a list of
checks and their descriptions, get check results, specify checks to refresh, and get the
refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:

The CreateCase , DescribeCases , DescribeAttachment , and ResolveCase operations
create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.

The DescribeCommunications , AddCommunicationToCase , and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support
cases.

The DescribeServices and DescribeSeverityLevels operations return Amazon Web Services service names, service codes, service categories, and problem
severity levels. You use these values when you call the CreateCase operation.

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more
information, see Trusted Advisor in the
Amazon Web Services Support User Guide .
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing
Process .
For more information about this service and the endpoints to use, see About the
Amazon Web Services Support API in the Amazon Web Services Support User Guide .

Endpoints 20

  • POSTAdd attachments to set/#X-Amz-Target=AWSSupport_20130415.AddAttachmentsToSetAdds 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.…
  • POSTAdd communication to case/#X-Amz-Target=AWSSupport_20130415.AddCommunicationToCaseAdds additional customer communication to a Amazon Web Services Support case. Use the caseId parameter to identify the case to which to add communication. To…
  • POSTComplete attachment upload/#X-Amz-Target=AWSSupport_20130415.CompleteAttachmentUploadCompletes an attachment upload that was started with GetAttachmentUploadLinks . After you upload a part of the file to its presigned Amazon S3 URL, call…
  • POSTCreate case/#X-Amz-Target=AWSSupport_20130415.CreateCaseCreates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create…
  • POSTDescribe attachment/#X-Amz-Target=AWSSupport_20130415.DescribeAttachmentReturns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are…
  • POSTDescribe attachment upload status/#X-Amz-Target=AWSSupport_20130415.DescribeAttachmentUploadStatusReturns the current status, file name, and progress of a multipart attachment upload that was started with GetAttachmentUploadLinks . Use this operation to…
  • POSTDescribe cases/#X-Amz-Target=AWSSupport_20130415.DescribeCasesReturns 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…
  • POSTDescribe communications/#X-Amz-Target=AWSSupport_20130415.DescribeCommunicationsReturns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId…
  • POSTDescribe create case options/#X-Amz-Target=AWSSupport_20130415.DescribeCreateCaseOptionsReturns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode ,…
  • POSTDescribe services/#X-Amz-Target=AWSSupport_20130415.DescribeServicesReturns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your…
  • POSTDescribe severity levels/#X-Amz-Target=AWSSupport_20130415.DescribeSeverityLevelsReturns 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 data type that you…
  • POSTDescribe supported languages/#X-Amz-Target=AWSSupport_20130415.DescribeSupportedLanguagesReturns a list of supported languages for a specified categoryCode , issueType and serviceCode . The returned supported languages will include a ISO 639-1…
  • POSTDescribe trusted advisor check refresh statuses/#X-Amz-Target=AWSSupport_20130415.DescribeTrustedAdvisorCheckRefreshStatusesReturns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the…
  • POSTDescribe trusted advisor check result/#X-Amz-Target=AWSSupport_20130415.DescribeTrustedAdvisorCheckResultReturns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks…
  • POSTDescribe trusted advisor check summaries/#X-Amz-Target=AWSSupport_20130415.DescribeTrustedAdvisorCheckSummariesReturns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the…
  • POSTDescribe trusted advisor checks/#X-Amz-Target=AWSSupport_20130415.DescribeTrustedAdvisorChecksReturns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.…
  • POSTGet attachment download link/#X-Amz-Target=AWSSupport_20130415.GetAttachmentDownloadLinkReturns a presigned download URL for an attachment that is associated with a case communication. The download link works for an attachment of any size,…
  • POSTGet attachment upload links/#X-Amz-Target=AWSSupport_20130415.GetAttachmentUploadLinksReturns one or more presigned upload URLs for uploading a large file attachment to a support case by using a multipart upload workflow. The maximum file size…
  • POSTRefresh trusted advisor check/#X-Amz-Target=AWSSupport_20130415.RefreshTrustedAdvisorCheckRefreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation. Some…
  • POSTResolve case/#X-Amz-Target=AWSSupport_20130415.ResolveCaseResolves a support case. This operation takes a caseId and returns the initial and final state of the case. You must have an Amazon Web Services Business…

API details

Base URL
https://support.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
20 operations on 20 pathsPOST 20
Description format
AWS Smithy model, API version 2013-04-15

How to test the AWS Support in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Support collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add attachments to set” (POST /#X-Amz-Target=AWSSupport_20130415.AddAttachmentsToSet), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Support?

Amazon Web Services Support The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web… It is listed under Developer tools and has 20 endpoints.

Who publishes the AWS Support?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Support?

Requests go to https://support.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Support?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Support have?

20 operations on 20 paths (20 POST).

Is forking the AWS Support free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.