AWS.Support (aws-elixir v0.8.0) 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.

You can use the API to manage your support cases programmatically. The AWS Support API 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 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.

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 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.

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.

Link to this section Summary

Functions

Adds one or more attachments to an attachment set.

Adds additional customer communication to an AWS Support case.

Creates a case in the AWS Support Center.

Returns the attachment that has the specified ID.

Returns a list of cases that you specify by passing one or more case IDs.

Returns communications and attachments for one or more support cases.

Returns the current list of AWS services and a list of service categories for each service.

Returns the list of severity levels that you can assign to a support case.

Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.

Returns the results of the AWS Trusted Advisor check that has the specified check ID.

Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.

Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata.

Refreshes the AWS Trusted Advisor check that you specify using the check ID.

Link to this section Functions

Link to this function

add_attachments_to_set(client, input, options \\ [])

View Source

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.

Link to this function

add_communication_to_case(client, input, options \\ [])

View Source

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.

Link to this function

create_case(client, input, options \\ [])

View Source

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:

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, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Link to this function

describe_attachment(client, input, options \\ [])

View Source

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.

Link to this function

describe_cases(client, input, options \\ [])

View Source

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 the CaseDetails 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, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Link to this function

describe_communications(client, input, options \\ [])

View Source

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.

Link to this function

describe_services(client, input, options \\ [])

View Source

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.

Link to this function

describe_severity_levels(client, input, options \\ [])

View Source

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 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.

Link to this function

describe_trusted_advisor_check_refresh_statuses(client, input, options \\ [])

View Source

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, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Link to this function

describe_trusted_advisor_check_result(client, input, options \\ [])

View Source

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 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.

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.

Link to this function

describe_trusted_advisor_check_summaries(client, input, options \\ [])

View Source

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, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Link to this function

describe_trusted_advisor_checks(client, input, options \\ [])

View Source

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.

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.

Link to this function

refresh_trusted_advisor_check(client, input, options \\ [])

View Source

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, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

Link to this function

resolve_case(client, input, options \\ [])

View Source

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.