com.amazonaws.services.support.package-info Maven / Gradle / Ivy
Show all versions of aws-java-sdk-support Show documentation
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
/**
* AWS Support
*
* 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.
*
*/
package com.amazonaws.services.support;