aws_support
AWS Support
The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types.
This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a
Business or Enterprise support plan, the SubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
The AWS Support service also exposes a set of AWS Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management operations:
Service names, issue categories, and available severity levels. The
DescribeServices
andDescribeSeverityLevels
operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call theCreateCase
operation.Case creation, case details, and case resolution. The
CreateCase
,DescribeCases
,DescribeAttachment
, andResolveCase
operations create AWS Support cases, retrieve information about cases, and resolve cases.Case communication. The
DescribeCommunications
,AddCommunicationToCase
, andAddAttachmentsToSet
operations retrieve and add communications and attachments to AWS Support cases.
The following list describes the operations available from the AWS Support service for Trusted Advisor:
DescribeTrustedAdvisorChecks
returns the list of checks that run against your AWS resources.Using the
checkId
for a specific check returned byDescribeTrustedAdvisorChecks
, you can callDescribeTrustedAdvisorCheckResult
to obtain the results for the check that you specified.DescribeTrustedAdvisorCheckSummaries
returns summarized results for one or more Trusted Advisor checks.RefreshTrustedAdvisorCheck
requests that Trusted Advisor rerun a specified check.DescribeTrustedAdvisorCheckRefreshStatuses
reports the refresh status of one or more checks.
For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.Summary
Functions
-
add_attachments_to_set(Client, Input)
Adds one or more attachments to an attachment set.
- add_attachments_to_set(Client, Input, Options)
-
add_communication_to_case(Client, Input)
Adds additional customer communication to an AWS Support case.
- add_communication_to_case(Client, Input, Options)
-
create_case(Client, Input)
Creates a case in the AWS Support Center.
- create_case(Client, Input, Options)
-
describe_attachment(Client, Input)
Returns the attachment that has the specified ID.
- describe_attachment(Client, Input, Options)
-
describe_cases(Client, Input)
Returns a list of cases that you specify by passing one or more case IDs.
- describe_cases(Client, Input, Options)
-
describe_communications(Client, Input)
Returns communications and attachments for one or more support cases.
- describe_communications(Client, Input, Options)
-
describe_services(Client, Input)
Returns the current list of AWS services and a list of service categories for each service.
- describe_services(Client, Input, Options)
-
describe_severity_levels(Client, Input)
Returns the list of severity levels that you can assign to an AWS Support case.
- describe_severity_levels(Client, Input, Options)
-
describe_trusted_advisor_check_refresh_statuses(Client, Input)
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.
- describe_trusted_advisor_check_refresh_statuses(Client, Input, Options)
-
describe_trusted_advisor_check_result(Client, Input)
Returns the results of the AWS Trusted Advisor check that has the specified check ID.
- describe_trusted_advisor_check_result(Client, Input, Options)
-
describe_trusted_advisor_check_summaries(Client, Input)
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.
- describe_trusted_advisor_check_summaries(Client, Input, Options)
-
describe_trusted_advisor_checks(Client, Input)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata.
- describe_trusted_advisor_checks(Client, Input, Options)
-
refresh_trusted_advisor_check(Client, Input)
Refreshes the AWS Trusted Advisor check that you specify using the check ID.
- refresh_trusted_advisor_check(Client, Input, Options)
-
resolve_case(Client, Input)
Resolves a support case.
- resolve_case(Client, Input, Options)
Functions
add_attachments_to_set(Client, Input)
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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
add_attachments_to_set(Client, Input, Options)
add_communication_to_case(Client, Input)
Adds additional customer communication to an AWS 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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
add_communication_to_case(Client, Input, Options)
create_case(Client, Input)
Creates a case in the AWS Support Center.
This operation is similar to how you create a case in the AWS Support Center Create Case page.
The AWS 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 AWS Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase
request returns an AWS Support case
number. You can use the DescribeCases
operation and specify the case
number to get existing AWS Support cases. After you create a case, use the
AddCommunicationToCase
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. Use the DescribeCases
operation to get the displayId
.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
create_case(Client, Input, Options)
describe_attachment(Client, Input)
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
objects that are
returned by the DescribeCommunications
operation.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_attachment(Client, Input, Options)
describe_cases(Client, Input)
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 data types.
One or more
nextToken
values, which specify where to paginate the returned records represented by theCaseDetails
objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_cases(Client, Input, Options)
describe_communications(Client, Input)
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 12 months after creation. If a case was created more than 12 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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_communications(Client, Input, Options)
describe_services(Client, Input)
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
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 AWS Support Center Create Case
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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_services(Client, Input, Options)
describe_severity_levels(Client, Input)
Returns the list of severity levels that you can assign to an AWS Support case.
The severity level for a case is also a field in the CaseDetails
data
type that you include for a CreateCase
request.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_severity_levels(Client, Input, Options)
describe_trusted_advisor_check_refresh_statuses(Client, Input)
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
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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_trusted_advisor_check_refresh_statuses(Client, Input, Options)
describe_trusted_advisor_check_result(Client, Input)
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
operation.
The response contains a TrustedAdvisorCheckResult
object, which contains
these three objects:
TrustedAdvisorCategorySpecificSummary
TrustedAdvisorResourceDetail
TrustedAdvisorResourcesSummary
In addition, the response contains these fields:
status - The alert status of the check: "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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_trusted_advisor_check_result(Client, Input, Options)
describe_trusted_advisor_check_summaries(Client, Input)
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
operation.
The response contains an array of TrustedAdvisorCheckSummary
objects.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_trusted_advisor_check_summaries(Client, Input, Options)
describe_trusted_advisor_checks(Client, Input)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata.
You must specify a language code. The AWS Support API currently supports
English ("en") and Japanese ("ja"). The response contains a
TrustedAdvisorCheckDescription
object for each check. You must set the
AWS Region to us-east-1.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
describe_trusted_advisor_checks(Client, Input, Options)
refresh_trusted_advisor_check(Client, Input)
Refreshes the AWS Trusted Advisor check that you specify using the check ID.
You can get the check IDs by calling the DescribeTrustedAdvisorChecks
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
object.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.
refresh_trusted_advisor_check(Client, Input, Options)
resolve_case(Client, Input)
Resolves a support case.
This operation takes a caseId
and returns the initial and final state of
the case.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, theSubscriptionRequiredException
error message appears. For information about changing your support plan,
see AWS Support.