ex_aws_support v2.0.0 ExAws.Support View Source

Operations for AWS Support API

Link to this section Summary

Functions

Adds one or more attachments to an attachment set

Creates a new 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 that applies to each one

Returns the list of severity levels that you can assign to an AWS Support case

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

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

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs

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

Requests a refresh of the Trusted Advisor check that has the specified check_id

Takes a case_id and returns the initial state of the case along with the state of the case after the call to resolve_case completed

Link to this section Types

Link to this type

attachment() View Source
attachment() :: [data: binary(), file_name: binary()]

Link to this type

attachments() View Source
attachments() :: [attachment(), ...]

Link to this type

create_case_opts() View Source
create_case_opts() :: [
  attachment_set_id: binary(),
  category_code: binary(),
  cc_email_addresses: [binary(), ...],
  issue_type: binary(),
  language: binary(),
  service_code: binary(),
  severity_code: binary()
]

Link to this type

describe_cases_opts() View Source
describe_cases_opts() :: [
  after_time: binary(),
  before_time: binary(),
  case_id_list: [binary(), ...],
  display_id: binary(),
  include_communications: boolean(),
  include_resolved_cases: boolean(),
  language: binary(),
  max_results: integer(),
  next_token: binary()
]

Link to this type

describe_communications_opts() View Source
describe_communications_opts() :: [
  after_time: binary(),
  before_time: binary(),
  max_results: integer(),
  next_token: binary()
]

Link to this section Functions

Link to this function

add_attachments_to_set(attachments, attachment_set_id \\ nil) View Source
add_attachments_to_set(
  attachments :: attachments(),
  attachment_set_id :: binary() | nil
) :: ExAws.Operation.JSON.t()

Adds one or more attachments to an attachment set

If an attachment_set_id is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachment_set_id 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.

Link to this function

add_communication_to_case(case_id, attachment_set_id, communication_body, cc_email_addresses \\ []) View Source
add_communication_to_case(
  case_id :: binary(),
  attachment_set_id :: binary(),
  communication_body :: binary(),
  cc_email_addresses :: [binary(), ...] | []
) :: ExAws.Operation.JSON.t()

Adds additional customer communication to an AWS Support case

You use the case_id value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the cc_email_addresses value. The communication_body value contains the text of the communication.

The response indicates the success or failure of the request

Parameter Descriptions

  • attachment_set_id - The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling add_attachments_to_set/2

  • case_id - The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

  • cc_email_addresses - The email addresses in the CC line of an email to be added to the support case. List of Strings. Minimum number of 0 items. Maximum number of 10 items.

  • communication_body - The body of an email communication to add to the support case. Minimum length of 1. Maximum length of 8000.

Link to this function

create_case(subject, communication_body, opts \\ []) View Source
create_case(
  subject :: binary(),
  communication_body :: binary(),
  opts :: create_case_opts()
) :: ExAws.Operation.JSON.t()

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:

Parameter Descriptions

  • issue_type - 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." Note: Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center.

  • service_code - The code for an AWS service. You can get the possible service_code values by calling describe_services/2.

  • category_code - The category for the service defined for the service_code value. You also get the category code for a service by calling describe_services/2. Each AWS service defines its own set of category codes.

  • severity_code - 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 can get the possible severity_code values by calling describe_security_levels/1. For more information about the meaning of the codes, see SeverityLevel and Choosing a Severity.

  • subject - The Subject field on the AWS Support Center Create Case page.

  • communication_body - The Description field on the AWS Support Center Create Case page.

  • attachment_set_id - The ID of a set of attachments that has been created by using add_attachments_to_set/2

  • language - The human language in which AWS Support handles the case. English and Japanese are currently supported.

  • cc_email_addresses - The AWS Support Center CC field on the Create Case 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.

Note: To add additional communication or attachments to an existing case, use add_communication_to_case/4.

A successful create_case/3 request returns an AWS Support case number. Case numbers are used by the describe_cases operation to retrieve existing AWS Support cases.

Link to this function

describe_attachment(attachment_id) View Source
describe_attachment(attachment_id :: binary()) :: ExAws.Operation.JSON.t()

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 describe_communications/2 operation

Link to this function

describe_cases(opts \\ []) View Source
describe_cases(opts :: describe_cases_opts()) :: ExAws.Operation.JSON.t()

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 after_time and before_time request parameters. You can set values for the include_resolved_cases and include_communications 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 next_token values, which specify where to paginate the returned records represented by the CaseDetails objects.

Parameter Descriptions

  • after_time - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. String format is: YYYY-MM-DDTHH:MM, for example: 2018-12-19T16:40"

  • before_time - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

  • case_id_list - A list of ID numbers of the support cases you want returned. The maximum number of cases is 100. Note: A case_id in AWS is not the value that you see in AWS Support web pages. That is the display_id. Its a unique identifier returned when you create a case that includes your account id. The case ID is an alphanumeric string formatted as shown in this example: "case-12345678910-2013-c4c1d2bf33c5cf47"

  • display_id - This is the 10 digit number shown in the AWS Support web interface and labeled "Case Id"

  • include_resolved_cases - Specifies whether resolved support cases should be included in the describe_cases/1 results. The default is false. If you are not getting data back and you expect to, ensure that you are setting this to true.

  • language - The human language in which AWS Support handles the case. English and Japanese are currently supported.

  • max_results: The maximum number of results to return before paginating. Valid Range: Minimum value of 10. Maximum value of 100.

  • next_token: A resumption point for pagination. Returned by previous describe_cases call as "nextToken" in the JSON.

Link to this function

describe_communications(case_id, opts \\ []) View Source
describe_communications(
  case_id :: binary(),
  opts :: describe_communications_opts()
) :: ExAws.Operation.JSON.t()

Returns communications (and attachments) for one or more support cases

You can use the after_time and before_time 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 max_results and next_token parameters to control the pagination of the result set. Set max_results to the number of cases you want displayed on each page, and use next_token to specify the resumption of pagination.

Parameter Descriptions

  • after_time - The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation. String format is: YYYY-MM-DDTHH:MM, for example: 2018-12-19T16:40"

  • before_time - The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

  • case_id - Identifies what case you want attachment info for. REQUIRED.

  • max_results - The maximum number of results to return before paginating. Integer. Valid Range: Minimum value of 10. Maximum value of 100.

  • next_token - A resumption point for pagination

Link to this function

describe_services(language \\ "en", service_code_list \\ []) View Source
describe_services(
  language :: binary(),
  service_code_list :: [binary(), ...] | []
) :: ExAws.Operation.JSON.t()

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

Link to this function

describe_severity_levels(language \\ "en") View Source
describe_severity_levels(language :: binary()) :: ExAws.Operation.JSON.t()

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 create_case/1 request.

Parameter Descriptions

  • language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Link to this function

describe_trusted_advisor_check_refresh_statuses(check_ids) View Source
describe_trusted_advisor_check_refresh_statuses(check_ids :: binary()) ::
  ExAws.Operation.JSON.t()

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

Check IDs can be obtained by calling describe_trusted_advisor_checks/1.

Note: Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the describe_trusted_advisor_check_refresh_statuses operation for these checks causes an InvalidParameterValue error.

Link to this function

describe_trusted_advisor_check_result(check_id, language \\ "en") View Source
describe_trusted_advisor_check_result(
  check_id :: binary(),
  language :: binary()
) :: ExAws.Operation.JSON.t()

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

    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.

Link to this function

describe_trusted_advisor_check_summaries(check_ids) View Source
describe_trusted_advisor_check_summaries(check_ids :: [binary(), ...]) ::
  ExAws.Operation.JSON.t()

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs

check_ids can be obtained by calling describe_trusted_advisor_checks/1.

The response contains an array of TrustedAdvisorCheckSummary objects.

Link to this function

describe_trusted_advisor_checks(language \\ "en") View Source
describe_trusted_advisor_checks(language :: binary()) ::
  ExAws.Operation.JSON.t()

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.

Link to this function

refresh_trusted_advisor_check(check_id) View Source
refresh_trusted_advisor_check(check_id :: binary()) :: ExAws.Operation.JSON.t()

Requests a refresh of the Trusted Advisor check that has the specified check_id

Check IDs can be obtained by calling describe_trusted_advisor_checks/1

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the refresh_trusted_advisor_check/1 function for these checks causes an InvalidParameterValue error.

Link to this function

resolve_case(case_id) View Source
resolve_case(case_id :: binary()) :: ExAws.Operation.JSON.t()

Takes a case_id and returns the initial state of the case along with the state of the case after the call to resolve_case completed