Client

support

R Documentation

AWS Support¶

Description¶

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 doesn't 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.

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

The create_case, describe_cases, describe_attachment, and resolve_case operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
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 describe_services and describe_severity_levels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the create_case operation.

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Usage¶

support(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - 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⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- 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

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

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.

Service syntax¶

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",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

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_create_case_options: Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability
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_supported_languages: Returns a list of supported languages for a specified categoryCode, issueType and serviceCode; 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; 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

Examples¶

## Not run: 
svc <- support()
svc$add_attachments_to_set(
  Foo = 123
)

## End(Not run)