Crate aws_sdk_support

source ·
Expand 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:

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.

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.

Modules

Client and fluent builders for calling the service.
Configuration for the service.
Endpoint resolution functionality
All error types that operations can return. Documentation on these types is copied from the model.
Input structures for operations. Documentation on these types is copied from the model.
Base Middleware Stack
Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.
All operations that this crate can perform.
Output structures for operations. Documentation on these types is copied from the model.
Paginators for the service
Data primitives referenced by other data types.

Structs

App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for AWS Support
Service config.
AWS SDK Credentials
EndpointDeprecated
API Endpoint
The region to send requests to.

Enums

All possible error types for this service.

Statics

Crate version number.