support: AWS Support

Description Usage Arguments Value Service syntax Operations Examples

View source: R/support_service.R

Description

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

The following list describes the operations available from the AWS Support service for Trusted Advisor:

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.

Usage

1
support(config = list())

Arguments

config

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- support(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    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 AWS Support case
create_case Creates a case in the AWS 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 AWS services and a list of service categories for each service
describe_severity_levels Returns the list of severity levels that you can assign to an AWS Support case
describe_trusted_advisor_check_refresh_statuses Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs
describe_trusted_advisor_check_result Returns the results of the AWS Trusted Advisor check that has the specified check ID
describe_trusted_advisor_checks Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata
describe_trusted_advisor_check_summaries Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified
refresh_trusted_advisor_check Refreshes the AWS Trusted Advisor check that you specify using the check ID
resolve_case Resolves a support case

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- support()
svc$add_attachments_to_set(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.