@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSupport
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSupport
instead.
The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
The AWS 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 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 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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 AWS Support case.
|
CreateCaseResult |
createCase(CreateCaseRequest createCaseRequest)
Creates a new case in the AWS 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.
|
DescribeServicesResult |
describeServices()
Simplified method form for invoking the DescribeServices operation.
|
DescribeServicesResult |
describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of AWS services and a list of service categories that applies to each one.
|
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 an AWS Support case.
|
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 name, ID, category, description, and
metadata.
|
DescribeTrustedAdvisorCheckSummariesResult |
describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
|
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)
Requests a refresh of the Trusted Advisor check that has the specified check ID.
|
ResolveCaseResult |
resolveCase()
Simplified method form for invoking the ResolveCase operation.
|
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)
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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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.
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set. If an attachmentSetId
is not specified, a new
attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId
is specified, the attachments are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to a case or case communication.
The set is available for one hour after it is created; the expiryTime
returned in the response
indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any
attachment in the set is 5 MB.
addAttachmentsToSetRequest
- 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 3 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.AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case. You use the caseId
value to identify
the case to add communication to. You can list a set of email addresses to copy on the communication using the
ccEmailAddresses
value. The communicationBody
value contains the text of the
communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
addCommunicationToCaseRequest
- To be written.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not 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.CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
serviceCode. The code for an AWS service. You obtain the serviceCode
by calling
DescribeServices.
categoryCode. The category for the service defined for the serviceCode
value. You also obtain
the category code for a service by calling DescribeServices. Each AWS service defines its own set of
category codes.
severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
subject. The Subject field on the AWS Support Center Create Case page.
communicationBody. The Description field on the AWS Support Center Create Case page.
attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.
To add additional communication or attachments to an existing case, use AddCommunicationToCase.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.
createCaseRequest
- 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.DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)
Returns the attachment that has the specified ID. 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.
describeAttachmentRequest
- 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.DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases
by date by setting values for the afterTime
and beforeTime
request parameters. You can
set values for the includeResolvedCases
and includeCommunications
request parameters to
control how much information is returned.
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.
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.
describeCasesRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.DescribeCasesResult describeCases()
describeCases(DescribeCasesRequest)
DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications (and attachments) for one or more support cases. You can use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to
restrict the results to a particular 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
result set. Set maxResults
to the number of cases you want displayed on each page, and use
nextToken
to specify the resumption of pagination.
describeCommunicationsRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of AWS services and a list of service categories that applies to each one. 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 are displayed in the Service and
Category drop-down lists on the AWS Support Center Create Case page. The values in those fields,
however, do not necessarily match the service codes and categories returned by the DescribeServices
request. Always use the service codes and categories obtained programmatically. This practice ensures that you
always have the most recent set of service and category codes.
describeServicesRequest
- InternalServerErrorException
- An internal server error occurred.DescribeServicesResult describeServices()
DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
describeSeverityLevelsRequest
- InternalServerErrorException
- An internal server error occurred.DescribeSeverityLevelsResult describeSeverityLevels()
DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation.
Use of the DescribeTrustedAdvisorCheckRefreshStatuses
operation for these checks causes an
InvalidParameterValue
error.
describeTrustedAdvisorCheckRefreshStatusesRequest
- InternalServerErrorException
- An internal server error occurred.DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
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: "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.
describeTrustedAdvisorCheckResultRequest
- InternalServerErrorException
- An internal server error occurred.DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects.
describeTrustedAdvisorCheckSummariesRequest
- InternalServerErrorException
- An internal server error occurred.DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
describeTrustedAdvisorChecksRequest
- InternalServerErrorException
- An internal server error occurred.RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the
RefreshTrustedAdvisorCheck
operation for these checks causes an InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
checkId. The unique identifier for the check.
refreshTrustedAdvisorCheckRequest
- InternalServerErrorException
- An internal server error occurred.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.
resolveCaseRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.ResolveCaseResult resolveCase()
resolveCase(ResolveCaseRequest)
void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.