Amazon Web Services Support
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that
does not have a Business, Enterprise On-Ramp, or Enterprise Support
plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web Services Support.
The Amazon Web Services 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 Amazon Web Services Support case management operations:
Service names, issue categories, and available severity levels - The
describe_services and
describe_severity_levels
operations return Amazon Web Services service names, service codes,
service categories, and problem severity levels. You use these
values when you call the create_case
operation.
Case creation, case details, and case resolution - The
create_case,
describe_cases,
describe_attachment, and
resolve_case operations create Amazon Web
Services Support cases, retrieve information about cases, and
resolve cases.
Case communication - The
describe_communications,
add_communication_to_case,
and add_attachments_to_set
operations retrieve and add communications and attachments to Amazon
Web Services Support cases.
The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:
describe_trusted_advisor_checks
returns the list of checks that run against your Amazon Web Services
resources.
Using the checkId for a specific check returned by
describe_trusted_advisor_checks,
you can call
describe_trusted_advisor_check_result
to obtain the results for the check that you specified.
describe_trusted_advisor_check_summaries
returns summarized results for one or more Trusted Advisor checks.
refresh_trusted_advisor_check
requests that Trusted Advisor rerun a specified check.
describe_trusted_advisor_check_refresh_statuses
reports the refresh status of one or more checks.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
See About the Amazon Web Services Support API in the Amazon Web Services 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.
support(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- support(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| add_attachments_to_set | Adds one or more attachments to an attachment set |
| add_communication_to_case | Adds additional customer communication to an Amazon Web Services Support case |
| create_case | Creates a case in the Amazon Web Services Support Center |
| describe_attachment | Returns the attachment that has the specified ID |
| describe_cases | Returns a list of cases that you specify by passing one or more case IDs |
| describe_communications | Returns communications and attachments for one or more support cases |
| describe_services | Returns the current list of Amazon Web Services services and a list of service categories for each service |
| describe_severity_levels | Returns the list of severity levels that you can assign to a support case |
| describe_trusted_advisor_check_refresh_statuses | Returns the refresh status of the Trusted Advisor checks that have the specified check IDs |
| describe_trusted_advisor_check_result | Returns the results of the Trusted Advisor check that has the specified check ID |
| describe_trusted_advisor_checks | Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata |
| describe_trusted_advisor_check_summaries | Returns the results for the Trusted Advisor check summaries for the check IDs that you specified |
| refresh_trusted_advisor_check | Refreshes the Trusted Advisor check that you specify using the check ID |
| resolve_case | Resolves a support case |
if (FALSE) {
svc <- support()
svc$add_attachments_to_set(
Foo = 123
)
}
Run the code above in your browser using DataLab