aws-elixir v0.0.8 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.
The AWS Support service also exposes a set of 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` 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 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.
Summary
Functions
Adds one or more attachments to an 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
Adds additional customer communication to an AWS Support case. You use the
CaseId
value to identify the case to add communication to. You can list a
set of email addresses to copy on the communication using the
CcEmailAddresses
value. The CommunicationBody
value contains the text
of the communication
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information
Returns the attachment that has the specified ID. 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.
In addition, you can filter the cases by date by setting values for the
AfterTime
and BeforeTime
request parameters. You can set values for the
IncludeResolvedCases
and IncludeCommunications
request parameters to
control how much information is returned
Returns communications (and attachments) for one or more support cases. You
can use the AfterTime
and BeforeTime
parameters to filter by date. You
can use the CaseId
parameter to restrict the results to a particular
case
Returns the current list of AWS services and a list of service categories
that applies to each one. 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 included in any CreateCase
request
Returns the refresh status of the Trusted Advisor checks that have the
specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
Returns the results of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
Returns the summaries of the results of the Trusted Advisor checks that
have the specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
Returns information about all available Trusted Advisor checks, including
name, ID, category, description, and metadata. You must specify a language
code; English (“en”) and Japanese (“ja”) are currently supported. The
response contains a TrustedAdvisorCheckDescription
for each check
Requests a refresh of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
Takes a CaseId
and returns the initial state of the case along with the
state of the case after the call to ResolveCase
completed
Functions
Adds one or more attachments to an 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.
An attachment set is a temporary container for attachments that are to be
added to a case or case communication. The set is available for one hour
after it is created; the ExpiryTime
returned in the response indicates
when the set expires. The maximum number of attachments in a set is 3, and
the maximum size of any attachment in the set is 5 MB.
Adds additional customer communication to an AWS Support case. You use the
CaseId
value to identify the case to add communication to. You can list a
set of email addresses to copy on the communication using the
CcEmailAddresses
value. The CommunicationBody
value contains the text
of the communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
- **IssueType.** The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
- **ServiceCode.** The code for an AWS service. You obtain the `ServiceCode` by calling `DescribeServices`.
- **CategoryCode.** The category for the service defined for the `ServiceCode` value. You also obtain the category code for a service by calling `DescribeServices`. Each AWS service defines its own set of category codes.
- **SeverityCode.** A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling `DescribeSeverityLevels`.
- **Subject.** The **Subject** field on the AWS Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page.
- **CommunicationBody.** The **Description** field on the AWS Support Center [Create Case](https://console.aws.amazon.com/support/home#/case/create) page.
- **AttachmentSetId.** The ID of a set of attachments that has been created by using `AddAttachmentsToSet`.
- **Language.** The human language in which AWS Support handles the case. English and Japanese are currently supported.
- **CcEmailAddresses.** The AWS Support Center **CC** field on the [Create Case](https://console.aws.amazon.com/support/home#/case/create) page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an [AWS SDK](http://aws.amazon.com/tools/).
Returns the attachment that has the specified ID. 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.
In addition, you can filter the cases by date by setting values for the
AfterTime
and BeforeTime
request parameters. You can set values for the
IncludeResolvedCases
and IncludeCommunications
request parameters to
control how much information is returned.
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.
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 the `CaseDetails` objects.
Returns communications (and attachments) for one or more support cases. You
can use the AfterTime
and BeforeTime
parameters to filter by date. You
can use the CaseId
parameter to restrict the results to a particular
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 result set. Set MaxResults
to the number of cases you
want displayed on each page, and use NextToken
to specify the resumption
of pagination.
Returns the current list of AWS services and a list of service categories
that applies to each one. 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 are
displayed in the Service and Category drop-down lists on the AWS
Support Center Create
Case page. The
values in those fields, however, do not necessarily match the service codes
and categories returned by the DescribeServices
request. Always use the
service codes and categories obtained programmatically. This practice
ensures that you always have the most recent set of service and category
codes.
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 included in any CreateCase
request.
Returns the refresh status of the Trusted Advisor checks that have the
specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
.
Returns the results of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
.
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.
Returns the summaries of the results of the Trusted Advisor checks that
have the specified check IDs. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
.
The response contains an array of TrustedAdvisorCheckSummary
objects.
Returns information about all available Trusted Advisor checks, including
name, ID, category, description, and metadata. You must specify a language
code; English (“en”) and Japanese (“ja”) are currently supported. The
response contains a TrustedAdvisorCheckDescription
for each check.
Requests a refresh of the Trusted Advisor check that has the specified
check ID. Check IDs can be obtained by calling
DescribeTrustedAdvisorChecks
.
The response contains a TrustedAdvisorCheckRefreshStatus
object, which
contains these fields:
- **Status.** The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
- **MillisUntilNextRefreshable.** The amount of time, in milliseconds, until the check is eligible for refresh.
- **CheckId.** The unique identifier for the check.