aws-sdk-support 0.17.0

AWS SDK for AWS Support
Documentation

aws-sdk-support

Please Note: The SDK is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.

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.

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 DescribeServices and DescribeSeverityLevels operations return Amazon Web Services 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 Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
  • Case communication - The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet 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:

  • DescribeTrustedAdvisorChecks returns the list of checks that run against your Amazon Web Services 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, 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.

Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-support to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = "0.47.0"
aws-sdk-support = "0.17.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_support as support;

#[tokio::main]
async fn main() -> Result<(), support::Error> {
    let config = aws_config::load_from_env().await;
    let client = support::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

Getting Help

License

This project is licensed under the Apache-2.0 License.