Crate aws_sdk_support[−][src]
Expand description
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.
Crate Organization
The entry point for most customers will be Client
. Client
exposes one method for each API offered
by the service.
Some APIs require complex or nested arguments. These exist in model
.
Lastly, errors that can be returned by the service are contained within error
. Error
defines a meta
error encompassing all possible errors that can be returned by the service.
The other modules within this crate are not required for normal usage.
Re-exports
Modules
Client and fluent builders for calling the service.
Configuration for the service.
Errors that can occur when calling the service.
Input structures for operations.
Base Middleware Stack
Data structures used by operation inputs/outputs.
All operations that this crate can perform.
Output structures for operations.
Structs
App name that can be configured with an AWS SDK client to become part of the user agent string.
Binary Blob Type
Stream of binary data
AWS SDK Credentials
DateTime in time.
API Endpoint
The region to send requests to.
Retry configuration for requests.
Enums
Statics
Crate version number.