AWSSupport (AWS SDK for Java

All Known Subinterfaces:

AWSSupportAsync

All Known Implementing Classes:

AbstractAWSSupport, AbstractAWSSupportAsync, AWSSupportAsyncClient, AWSSupportClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSupport
```
Interface for accessing AWS Support.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSupport instead.

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:
- The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
- The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
- The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AddAttachmentsToSetResult`	`addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)` Adds one or more attachments to an attachment set.
`AddCommunicationToCaseResult`	`addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)` Adds additional customer communication to an Amazon Web Services Support case.
`CreateCaseResult`	`createCase(CreateCaseRequest createCaseRequest)` Creates a case in the Amazon Web Services Support Center.
`DescribeAttachmentResult`	`describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)` Returns the attachment that has the specified ID.
`DescribeCasesResult`	`describeCases()` Simplified method form for invoking the DescribeCases operation.
`DescribeCasesResult`	`describeCases(DescribeCasesRequest describeCasesRequest)` Returns a list of cases that you specify by passing one or more case IDs.
`DescribeCommunicationsResult`	`describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)` Returns communications and attachments for one or more support cases.
`DescribeCreateCaseOptionsResult`	`describeCreateCaseOptions(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest)` Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
`DescribeServicesResult`	`describeServices()` Simplified method form for invoking the DescribeServices operation.
`DescribeServicesResult`	`describeServices(DescribeServicesRequest describeServicesRequest)` Returns the current list of Amazon Web Services services and a list of service categories for each service.
`DescribeSeverityLevelsResult`	`describeSeverityLevels()` Simplified method form for invoking the DescribeSeverityLevels operation.
`DescribeSeverityLevelsResult`	`describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)` Returns the list of severity levels that you can assign to a support case.
`DescribeSupportedLanguagesResult`	`describeSupportedLanguages(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest)` Returns a list of supported languages for a specified `categoryCode`, `issueType` and `serviceCode`.
`DescribeTrustedAdvisorCheckRefreshStatusesResult`	`describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)` Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
`DescribeTrustedAdvisorCheckResultResult`	`describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)` Returns the results of the Trusted Advisor check that has the specified check ID.
`DescribeTrustedAdvisorChecksResult`	`describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)` Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.
`DescribeTrustedAdvisorCheckSummariesResult`	`describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)` Returns the results for the 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 refreshTrustedAdvisorCheckRequest)` Refreshes the Trusted Advisor check that you specify using the check ID.
`ResolveCaseResult`	`resolveCase()` Simplified method form for invoking the ResolveCase operation.
`ResolveCaseResult`	`resolveCase(ResolveCaseRequest resolveCaseRequest)` Resolves a support case.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://support.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://support.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://support.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addAttachmentsToSet
```
AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
```
    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, 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.
    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
```
AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
```
    Adds additional customer communication to an Amazon Web Services 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, 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.
    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
```
CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
```
    Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
    
    The Amazon Web Services 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 Amazon Web Services Support Center Create Case page.
    - Use the Service Quotas RequestServiceQuotaIncrease operation.
    A successful CreateCase request returns an Amazon Web Services Support case number. You can use the DescribeCases operation and specify the case number to get existing Amazon Web Services 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 Amazon Web Services Support Center. Use the DescribeCases operation to get the displayId.
    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.
    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
```
DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)
```
    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, 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.
    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
```
DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest)
```
    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, 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.
    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
```
DescribeCasesResult describeCases()
```
    Simplified method form for invoking the DescribeCases operation.
    
    See Also:
    
    describeCases(DescribeCasesRequest)
  - describeCommunications
```
DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
```
    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, 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.
    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
  - describeCreateCaseOptions
```
DescribeCreateCaseOptionsResult describeCreateCaseOptions(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest)
```
    Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the language categoryCode, issueType and serviceCode used to retrieve the CreateCaseOptions.
    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.
    Parameters:
    
    describeCreateCaseOptionsRequest -
    
    Returns:
    
    Result of the DescribeCreateCaseOptions operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - describeServices
```
DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
```
    Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services 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 Amazon Web Services 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, 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.
    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
```
DescribeServicesResult describeServices()
```
    Simplified method form for invoking the DescribeServices operation.
    
    See Also:
    
    describeServices(DescribeServicesRequest)
  - describeSeverityLevels
```
DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
```
    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, 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.
    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
```
DescribeSeverityLevelsResult describeSeverityLevels()
```
    Simplified method form for invoking the DescribeSeverityLevels operation.
    
    See Also:
    
    describeSeverityLevels(DescribeSeverityLevelsRequest)
  - describeSupportedLanguages
```
DescribeSupportedLanguagesResult describeSupportedLanguages(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest)
```
    Returns a list of supported languages for a specified categoryCode, issueType and serviceCode. The returned supported languages will include a ISO 639-1 code for the language, and the language display name.
    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.
    Parameters:
    
    describeSupportedLanguagesRequest -
    
    Returns:
    
    Result of the DescribeSupportedLanguages operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorCheckRefreshStatuses
```
DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
```
    Returns the refresh status of the 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, 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.
    To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
    Parameters:
    
    describeTrustedAdvisorCheckRefreshStatusesRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorCheckResult
```
DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
```
    Returns the results of the 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, 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.
    To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
    Parameters:
    
    describeTrustedAdvisorCheckResultRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorCheckSummaries
```
DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
```
    Returns the results for the 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, 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.
    To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
    Parameters:
    
    describeTrustedAdvisorCheckSummariesRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - describeTrustedAdvisorChecks
```
DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
```
    Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code.
    
    The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
    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.
    
    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.
    To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
    Parameters:
    
    describeTrustedAdvisorChecksRequest -
    
    Returns:
    
    Result of the DescribeTrustedAdvisorChecks operation returned by the service.
    
    Throws:
    
    InternalServerErrorException - An internal server error occurred.
    
    ThrottlingException - You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.
    
    See Also:
    
    AWS API Documentation
  - refreshTrustedAdvisorCheck
```
RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
```
    Refreshes the 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, 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.
    To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
    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
```
ResolveCaseResult resolveCase(ResolveCaseRequest resolveCaseRequest)
```
    Resolves a support case. This operation takes a caseId and returns the initial and final state of the case.
    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.
    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
```
ResolveCaseResult resolveCase()
```
    Simplified method form for invoking the ResolveCase operation.
    
    See Also:
    
    resolveCase(ResolveCaseRequest)
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.780

Interface AWSSupport

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

addAttachmentsToSet

addCommunicationToCase

createCase

describeAttachment

describeCases

describeCases

describeCommunications

describeCreateCaseOptions

describeServices

describeServices

describeSeverityLevels

describeSeverityLevels

describeSupportedLanguages

describeTrustedAdvisorCheckRefreshStatuses

describeTrustedAdvisorCheckResult

describeTrustedAdvisorCheckSummaries

describeTrustedAdvisorChecks

refreshTrustedAdvisorCheck

resolveCase

resolveCase

shutdown

getCachedResponseMetadata