AWSSupportClient (AWS SDK for Java

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

All Implemented Interfaces:

AWSSupport

Direct Known Subclasses:

AWSSupportAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSupportClient
extends AmazonWebServiceClient
implements AWSSupport
```
Client for accessing AWS Support. 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 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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.support.AWSSupport
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Constructor and Description
`AWSSupportClient()` Deprecated. use `AWSSupportClientBuilder.defaultClient()`
`AWSSupportClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AWSSupportClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AWSSupportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AWSSupportClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddAttachmentsToSetResult`	`addAttachmentsToSet(AddAttachmentsToSetRequest request)` Adds one or more attachments to an attachment set.
`AddCommunicationToCaseResult`	`addCommunicationToCase(AddCommunicationToCaseRequest request)` Adds additional customer communication to an AWS Support case.
`static AWSSupportClientBuilder`	`builder()`
`CreateCaseResult`	`createCase(CreateCaseRequest request)` Creates a case in the AWS Support Center.
`DescribeAttachmentResult`	`describeAttachment(DescribeAttachmentRequest request)` Returns the attachment that has the specified ID.
`DescribeCasesResult`	`describeCases()` Simplified method form for invoking the DescribeCases operation.
`DescribeCasesResult`	`describeCases(DescribeCasesRequest request)` Returns a list of cases that you specify by passing one or more case IDs.
`DescribeCommunicationsResult`	`describeCommunications(DescribeCommunicationsRequest request)` Returns communications and attachments for one or more support cases.
`DescribeServicesResult`	`describeServices()` Simplified method form for invoking the DescribeServices operation.
`DescribeServicesResult`	`describeServices(DescribeServicesRequest request)` Returns the current list of AWS services and a list of service categories for each service.
`DescribeSeverityLevelsResult`	`describeSeverityLevels()` Simplified method form for invoking the DescribeSeverityLevels operation.
`DescribeSeverityLevelsResult`	`describeSeverityLevels(DescribeSeverityLevelsRequest request)` Returns the list of severity levels that you can assign to a support case.
`DescribeTrustedAdvisorCheckRefreshStatusesResult`	`describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)` Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.
`DescribeTrustedAdvisorCheckResultResult`	`describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest request)` Returns the results of the AWS Trusted Advisor check that has the specified check ID.
`DescribeTrustedAdvisorChecksResult`	`describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest request)` Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata.
`DescribeTrustedAdvisorCheckSummariesResult`	`describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest request)` Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.
`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 request)` Refreshes the AWS Trusted Advisor check that you specify using the check ID.
`ResolveCaseResult`	`resolveCase()` Simplified method form for invoking the ResolveCase operation.
`ResolveCaseResult`	`resolveCase(ResolveCaseRequest request)` Resolves a support case.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

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

- Constructor Detail
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient()
```
    Deprecated. use AWSSupportClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on AWS Support. 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
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on AWS Support. 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
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSSupportClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(AWSCredentials awsCredentials,
                                    ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
  - AWSSupportClient
```
@Deprecated
public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider,
                                    ClientConfiguration clientConfiguration,
                                    RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AWSSupportClientBuilder builder()
```
  - addAttachmentsToSet
```
public AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest request)
```
    Adds one or more attachments to an attachment set.
    
    An attachment set is a temporary container for attachments that you add to a case or case communication. The set is available for 1 hour after it's created. The expiryTime returned in the response is when the set expires.
    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.
    Specified by:
    
    addAttachmentsToSet in interface AWSSupport
    
    Parameters:
    
    addAttachmentsToSetRequest -
    
    Returns:
    
    Result of the AddAttachmentsToSet operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
    
    AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
    
    AttachmentSetSizeLimitExceededException - A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB per attachment.
    
    AttachmentLimitExceededException - The limit for the number of attachment sets created in a short period of time has been exceeded.
    
    See Also:
    
    AWS API Documentation
  - addCommunicationToCase
```
public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest request)
```
    Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using the ccEmailAddresses parameter. The communicationBody value contains the text of the communication.
    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.
    Specified by:
    
    addCommunicationToCase in interface AWSSupport
    
    Parameters:
    
    addCommunicationToCaseRequest -
    
    Returns:
    
    Result of the AddCommunicationToCase operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    CaseIdNotFoundException - The requested caseId couldn't be located.
    
    AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
    
    AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
    
    See Also:
    
    AWS API Documentation
  - createCase
```
public CreateCaseResult createCase(CreateCaseRequest request)
```
    Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page.
    
    The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
    - Submit a request from the AWS Support Center Create Case page.
    - Use the Service Quotas RequestServiceQuotaIncrease operation.
    A successful CreateCase request returns an AWS Support case number. You can use the DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a case, use the AddCommunicationToCase operation to add additional communication or attachments to an existing case.
    
    The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to get the displayId.
    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.
    Specified by:
    
    createCase in interface AWSSupport
    
    Parameters:
    
    createCaseRequest -
    
    Returns:
    
    Result of the CreateCase operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    CaseCreationLimitExceededException - The case creation limit for the account has been exceeded.
    
    AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
    
    AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
    
    See Also:
    
    AWS API Documentation
  - describeAttachment
```
public DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest request)
```
    Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
    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.
    Specified by:
    
    describeAttachment in interface AWSSupport
    
    Parameters:
    
    describeAttachmentRequest -
    
    Returns:
    
    Result of the DescribeAttachment operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    DescribeAttachmentLimitExceededException - The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
    
    AttachmentIdNotFoundException - An attachment with the specified ID could not be found.
    
    See Also:
    
    AWS API Documentation
  - describeCases
```
public DescribeCasesResult describeCases(DescribeCasesRequest request)
```
    Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime and beforeTime parameters to filter the cases by date. You can set values for the includeResolvedCases and includeCommunications parameters to specify how much information to return.
    
    The response returns the following in JSON format:
    - One or more CaseDetails data types.
    - One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.
    Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
    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.
    Specified by:
    
    describeCases in interface AWSSupport
    
    Parameters:
    
    describeCasesRequest -
    
    Returns:
    
    Result of the DescribeCases operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    CaseIdNotFoundException - The requested caseId couldn't be located.
    
    See Also:
    
    AWS API Documentation
  - describeCases
```
public DescribeCasesResult describeCases()
```
    Description copied from interface: AWSSupport
    
    Simplified method form for invoking the DescribeCases operation.
    
    Specified by:
    
    describeCases in interface AWSSupport
    
    See Also:
    
    AWSSupport.describeCases(DescribeCasesRequest)
  - describeCommunications
```
public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest request)
```
    Returns communications and attachments for one or more support cases. Use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a specific case.
    
    Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
    
    You can use the maxResults and nextToken parameters to control the pagination of the results. Set maxResults to the number of cases that you want to display on each page, and use nextToken to specify the resumption of pagination.
    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.
    Specified by:
    
    describeCommunications in interface AWSSupport
    
    Parameters:
    
    describeCommunicationsRequest -
    
    Returns:
    
    Result of the DescribeCommunications operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    CaseIdNotFoundException - The requested caseId couldn't be located.
    
    See Also:
    
    AWS API Documentation
  - describeServices
```
public DescribeServicesResult describeServices(DescribeServicesRequest request)
```
    Returns the current list of AWS services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
    
    The service codes and category codes correspond to the values that appear in the Service and Category lists on the AWS Support Center Create Case page. The values in those fields don't necessarily match the service codes and categories returned by the DescribeServices operation. Always use the service codes and categories that the DescribeServices operation returns, so that you have the most recent set of service and category codes.
    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.
    Specified by:
    
    describeServices in interface AWSSupport
    
    Parameters:
    
    describeServicesRequest -
    
    Returns:
    
    Result of the DescribeServices operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - describeServices
```
public DescribeServicesResult describeServices()
```
    Description copied from interface: AWSSupport
    
    Simplified method form for invoking the DescribeServices operation.
    
    Specified by:
    
    describeServices in interface AWSSupport
    
    See Also:
    
    AWSSupport.describeServices(DescribeServicesRequest)
  - describeSeverityLevels
```
public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest request)
```
    Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
    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.
    Specified by:
    
    describeSeverityLevels in interface AWSSupport
    
    Parameters:
    
    describeSeverityLevelsRequest -
    
    Returns:
    
    Result of the DescribeSeverityLevels operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - describeSeverityLevels
```
public DescribeSeverityLevelsResult describeSeverityLevels()
```
    Description copied from interface: AWSSupport
    
    Simplified method form for invoking the DescribeSeverityLevels operation.
    
    Specified by:
    
    describeSeverityLevels in interface AWSSupport
    
    See Also:
    
    AWSSupport.describeSeverityLevels(DescribeSeverityLevelsRequest)
  - describeTrustedAdvisorCheckRefreshStatuses
```
public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)
```
    Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
    
    Some checks are refreshed automatically, and you can't return their refresh statuses by using the DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks, you might see an InvalidParameterValue error.
    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.
    Specified by:
    
    describeTrustedAdvisorCheckRefreshStatuses in interface AWSSupport
    
    Parameters:
    
    describeTrustedAdvisorCheckRefreshStatusesRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorCheckResult
```
public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest request)
```
    Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
    
    The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
    In addition, the response contains these fields:
    - status - The alert status of the check can be ok (green), warning (yellow), error (red), or not_available.
    - timestamp - The time of the last refresh of the check.
    - checkId - The unique identifier for the check.
    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.
    Specified by:
    
    describeTrustedAdvisorCheckResult in interface AWSSupport
    
    Parameters:
    
    describeTrustedAdvisorCheckResultRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorCheckSummaries
```
public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest request)
```
    Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
    
    The response contains an array of TrustedAdvisorCheckSummary objects.
    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.
    Specified by:
    
    describeTrustedAdvisorCheckSummaries in interface AWSSupport
    
    Parameters:
    
    describeTrustedAdvisorCheckSummariesRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorChecks
```
public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest request)
```
    Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The AWS Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1.
    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 names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
    Specified by:
    
    describeTrustedAdvisorChecks in interface AWSSupport
    
    Parameters:
    
    describeTrustedAdvisorChecksRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorChecks operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - refreshTrustedAdvisorCheck
```
public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest request)
```
    Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
    
    Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to refresh them, you might see the InvalidParameterValue error.
    
    The response contains a TrustedAdvisorCheckRefreshStatus object.
    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.
    Specified by:
    
    refreshTrustedAdvisorCheck in interface AWSSupport
    
    Parameters:
    
    refreshTrustedAdvisorCheckRequest -
    
    Returns:
    
    Result of the RefreshTrustedAdvisorCheck operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    See Also:
    
    AWS API Documentation
  - resolveCase
```
public ResolveCaseResult resolveCase(ResolveCaseRequest request)
```
    Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
    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.
    Specified by:
    
    resolveCase in interface AWSSupport
    
    Parameters:
    
    resolveCaseRequest -
    
    Returns:
    
    Result of the ResolveCase operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    CaseIdNotFoundException - The requested caseId couldn't be located.
    
    See Also:
    
    AWS API Documentation
  - resolveCase
```
public ResolveCaseResult resolveCase()
```
    Description copied from interface: AWSSupport
    
    Simplified method form for invoking the ResolveCase operation.
    
    Specified by:
    
    resolveCase in interface AWSSupport
    
    See Also:
    
    AWSSupport.resolveCase(ResolveCaseRequest)
  - getCachedResponseMetadata
```
public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSSupport
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSSupport
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSSupportClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.support.AWSSupport

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.support.AWSSupport

Constructor Detail

AWSSupportClient

AWSSupportClient

AWSSupportClient

AWSSupportClient

AWSSupportClient

AWSSupportClient

AWSSupportClient

Method Detail

builder

addAttachmentsToSet

addCommunicationToCase

createCase

describeAttachment

describeCases

describeCases

describeCommunications

describeServices

describeServices

describeSeverityLevels

describeSeverityLevels

describeTrustedAdvisorCheckRefreshStatuses

describeTrustedAdvisorCheckResult

describeTrustedAdvisorCheckSummaries

describeTrustedAdvisorChecks

refreshTrustedAdvisorCheck

resolveCase

resolveCase

getCachedResponseMetadata

shutdown