aws-elixir v0.6.0 AWS.Support View Source
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](http://aws.amazon.com/premiumsupport/).
- **Service names, issue categories, and available severity levels. **The `DescribeServices` and `DescribeSeverityLevels` operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the `CreateCase` operation.
- **Case creation, case details, and case resolution.** The `CreateCase`, `DescribeCases`, `DescribeAttachment`, and `ResolveCase` operations create AWS Support cases, retrieve information about cases, and resolve cases.
- **Case communication.** The `DescribeCommunications`, `AddCommunicationToCase`, and `AddAttachmentsToSet` operations retrieve and add communications and attachments to AWS Support cases.
- `DescribeTrustedAdvisorChecks` returns the list of checks that run against your AWS resources.
- Using the `checkId` for a specific check returned by `DescribeTrustedAdvisorChecks`, you can call `DescribeTrustedAdvisorCheckResult` 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.
Link to this section Summary
Functions
Adds one or more attachments to an attachment set.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Refreshes the AWS Trusted Advisor check that you specify using the check
ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks
operation.
Resolves a support case. This operation takes a caseId
and returns the
initial and final state of the case.
Link to this section Functions
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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](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.
- 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](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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.
- 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](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
describe_trusted_advisor_check_refresh_statuses(client, input, options \\ [])
View SourceReturns 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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
describe_trusted_advisor_check_result(client, input, options \\ [])
View SourceReturns 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`
- **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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
describe_trusted_advisor_check_summaries(client, input, options \\ [])
View SourceReturns 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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
Refreshes the AWS Trusted Advisor check that you specify using the check
ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).
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, the `SubscriptionRequiredException` error message appears. For information about changing your support plan, see [AWS Support](http://aws.amazon.com/premiumsupport/).