AWSSupportClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.support
Class AWSSupportClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.support.AWSSupportClient

All Implemented Interfaces:: AWSSupport

Direct Known Subclasses:: AWSSupportAsyncClient

public class AWSSupportClient
extends AmazonWebServiceClient
implements AWSSupport
extends AmazonWebServiceClient
implements AWSSupport

Client for accessing AWSSupport. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage with your AWS Support cases programmatically. It is built on the AWS Query API programming model and provides HTTP methods that take parameters and return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks you can run on your resources, specify checks to run and refresh, and check the status of checks you have submitted.

The following list describes the AWS Support case management actions:

Service names, issue categories, and available severity levels. The actions DescribeServices and DescribeSeverityLevels enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase action.
Case Creation, case details, and case resolution . The actions CreateCase, DescribeCases, and ResolveCase enable you to create AWS Support cases, retrieve them, and resolve them.
Case communication . The actions DescribeCaseCommunications and AddCommunicationToCase enable you to retrieve and add communication to AWS Support cases.

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

DescribeTrustedAdviserChecks
Using the CheckId for a specific check returned by DescribeTrustedAdviserChecks, you can call DescribeTrustedAdvisorCheckResult
Using DescribeTrustedAdvisorCheckSummaries, you can get summaries for a set of Trusted Advisor checks.
RefreshTrustedAdvisorCheck enables you to request that Trusted Advisor run the check again.
gets statuses on the checks you are running.

For authentication of requests, the AWS Support uses Signature Version 4 Signing Process .

See the AWS Support Developer Guide for information about how to use this service to manage create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

Constructor Summary
`AWSSupportClient()` Constructs a new client to invoke service methods on AWSSupport.
`AWSSupportClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials.
`AWSSupportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials and client configuration options.
`AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider.
`AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider and client configuration options.
`AWSSupportClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AWSSupport.

Method Summary
`AddCommunicationToCaseResult`	`addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)` This action adds additional customer communication to an AWS Support case.
`CreateCaseResult`	`createCase(CreateCaseRequest createCaseRequest)` Creates a new case in the AWS Support Center.
`DescribeCasesResult`	`describeCases()` This action returns a list of cases that you specify by passing one or more CaseIds.
`DescribeCasesResult`	`describeCases(DescribeCasesRequest describeCasesRequest)` This action returns a list of cases that you specify by passing one or more CaseIds.
`DescribeCommunicationsResult`	`describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)` This action returns communications regarding the support case.
`DescribeServicesResult`	`describeServices()` Returns the current list of AWS services and a list of service categories that applies to each one.
`DescribeServicesResult`	`describeServices(DescribeServicesRequest describeServicesRequest)` Returns the current list of AWS services and a list of service categories that applies to each one.
`DescribeSeverityLevelsResult`	`describeSeverityLevels()` This action returns the list of severity levels that you can assign to an AWS Support case.
`DescribeSeverityLevelsResult`	`describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)` This action returns the list of severity levels that you can assign to an AWS Support case.
`DescribeTrustedAdvisorCheckRefreshStatusesResult`	`describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)` Returns the status of all refresh requests Trusted Advisor checks called using RefreshTrustedAdvisorCheck.
`DescribeTrustedAdvisorCheckResultResult`	`describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)` This action responds with the results of a Trusted Advisor check.
`DescribeTrustedAdvisorChecksResult`	`describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)` This action enables you to get a list of the available Trusted Advisor checks.
`DescribeTrustedAdvisorCheckSummariesResult`	`describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)` This action enables you to get the latest summaries for Trusted Advisor checks that you specify in your request.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`RefreshTrustedAdvisorCheckResult`	`refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)` This action enables you to query the service to request a refresh for a specific Trusted Advisor check.
`ResolveCaseResult`	`resolveCase()` Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.
`ResolveCaseResult`	`resolveCase(ResolveCaseRequest resolveCaseRequest)` Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.
`void`	`setEndpoint(String endpoint, String serviceName, String regionId)` Overrides the default endpoint for this client ("support.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.support.AWSSupport
`setEndpoint, setRegion, shutdown`

Constructor Detail

AWSSupportClient

public AWSSupportClient()

Constructs a new client to invoke service methods on AWSSupport. A credentials provider chain will be used that searches for credentials in this order:

Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
Java System Properties - aws.accessKeyId and aws.secretKey
Instance profile credentials delivered through the Amazon EC2 metadata service