@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSupportAsync extends AWSSupport
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSupportAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<AddAttachmentsToSetResult> |
addAttachmentsToSetAsync(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set.
|
Future<AddAttachmentsToSetResult> |
addAttachmentsToSetAsync(AddAttachmentsToSetRequest addAttachmentsToSetRequest,
AsyncHandler<AddAttachmentsToSetRequest,AddAttachmentsToSetResult> asyncHandler)
Adds one or more attachments to an attachment set.
|
Future<AddCommunicationToCaseResult> |
addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
Adds additional customer communication to an Amazon Web Services Support case.
|
Future<AddCommunicationToCaseResult> |
addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest,
AsyncHandler<AddCommunicationToCaseRequest,AddCommunicationToCaseResult> asyncHandler)
Adds additional customer communication to an Amazon Web Services Support case.
|
Future<CreateCaseResult> |
createCaseAsync(CreateCaseRequest createCaseRequest)
Creates a case in the Amazon Web Services Support Center.
|
Future<CreateCaseResult> |
createCaseAsync(CreateCaseRequest createCaseRequest,
AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
Creates a case in the Amazon Web Services Support Center.
|
Future<DescribeAttachmentResult> |
describeAttachmentAsync(DescribeAttachmentRequest describeAttachmentRequest)
Returns the attachment that has the specified ID.
|
Future<DescribeAttachmentResult> |
describeAttachmentAsync(DescribeAttachmentRequest describeAttachmentRequest,
AsyncHandler<DescribeAttachmentRequest,DescribeAttachmentResult> asyncHandler)
Returns the attachment that has the specified ID.
|
Future<DescribeCasesResult> |
describeCasesAsync()
Simplified method form for invoking the DescribeCases operation.
|
Future<DescribeCasesResult> |
describeCasesAsync(AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
Simplified method form for invoking the DescribeCases operation with an AsyncHandler.
|
Future<DescribeCasesResult> |
describeCasesAsync(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
Future<DescribeCasesResult> |
describeCasesAsync(DescribeCasesRequest describeCasesRequest,
AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
Returns a list of cases that you specify by passing one or more case IDs.
|
Future<DescribeCommunicationsResult> |
describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications and attachments for one or more support cases.
|
Future<DescribeCommunicationsResult> |
describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest,
AsyncHandler<DescribeCommunicationsRequest,DescribeCommunicationsResult> asyncHandler)
Returns communications and attachments for one or more support cases.
|
Future<DescribeCreateCaseOptionsResult> |
describeCreateCaseOptionsAsync(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest)
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
|
Future<DescribeCreateCaseOptionsResult> |
describeCreateCaseOptionsAsync(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest,
AsyncHandler<DescribeCreateCaseOptionsRequest,DescribeCreateCaseOptionsResult> asyncHandler)
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
|
Future<DescribeServicesResult> |
describeServicesAsync()
Simplified method form for invoking the DescribeServices operation.
|
Future<DescribeServicesResult> |
describeServicesAsync(AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
Simplified method form for invoking the DescribeServices operation with an AsyncHandler.
|
Future<DescribeServicesResult> |
describeServicesAsync(DescribeServicesRequest describeServicesRequest)
Returns the current list of Amazon Web Services services and a list of service categories for each service.
|
Future<DescribeServicesResult> |
describeServicesAsync(DescribeServicesRequest describeServicesRequest,
AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
Returns the current list of Amazon Web Services services and a list of service categories for each service.
|
Future<DescribeSeverityLevelsResult> |
describeSeverityLevelsAsync()
Simplified method form for invoking the DescribeSeverityLevels operation.
|
Future<DescribeSeverityLevelsResult> |
describeSeverityLevelsAsync(AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
Simplified method form for invoking the DescribeSeverityLevels operation with an AsyncHandler.
|
Future<DescribeSeverityLevelsResult> |
describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to a support case.
|
Future<DescribeSeverityLevelsResult> |
describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest,
AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
Returns the list of severity levels that you can assign to a support case.
|
Future<DescribeSupportedLanguagesResult> |
describeSupportedLanguagesAsync(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest)
Returns a list of supported languages for a specified
categoryCode , issueType and
serviceCode . |
Future<DescribeSupportedLanguagesResult> |
describeSupportedLanguagesAsync(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest,
AsyncHandler<DescribeSupportedLanguagesRequest,DescribeSupportedLanguagesResult> asyncHandler)
Returns a list of supported languages for a specified
categoryCode , issueType and
serviceCode . |
Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> |
describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
|
Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> |
describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest,
AsyncHandler<DescribeTrustedAdvisorCheckRefreshStatusesRequest,DescribeTrustedAdvisorCheckRefreshStatusesResult> asyncHandler)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
|
Future<DescribeTrustedAdvisorCheckResultResult> |
describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
Returns the results of the Trusted Advisor check that has the specified check ID.
|
Future<DescribeTrustedAdvisorCheckResultResult> |
describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest,
AsyncHandler<DescribeTrustedAdvisorCheckResultRequest,DescribeTrustedAdvisorCheckResultResult> asyncHandler)
Returns the results of the Trusted Advisor check that has the specified check ID.
|
Future<DescribeTrustedAdvisorChecksResult> |
describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available Trusted Advisor checks, including the name, ID, category, description,
and metadata.
|
Future<DescribeTrustedAdvisorChecksResult> |
describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest,
AsyncHandler<DescribeTrustedAdvisorChecksRequest,DescribeTrustedAdvisorChecksResult> asyncHandler)
Returns information about all available Trusted Advisor checks, including the name, ID, category, description,
and metadata.
|
Future<DescribeTrustedAdvisorCheckSummariesResult> |
describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
|
Future<DescribeTrustedAdvisorCheckSummariesResult> |
describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest,
AsyncHandler<DescribeTrustedAdvisorCheckSummariesRequest,DescribeTrustedAdvisorCheckSummariesResult> asyncHandler)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
|
Future<RefreshTrustedAdvisorCheckResult> |
refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Refreshes the Trusted Advisor check that you specify using the check ID.
|
Future<RefreshTrustedAdvisorCheckResult> |
refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest,
AsyncHandler<RefreshTrustedAdvisorCheckRequest,RefreshTrustedAdvisorCheckResult> asyncHandler)
Refreshes the Trusted Advisor check that you specify using the check ID.
|
Future<ResolveCaseResult> |
resolveCaseAsync()
Simplified method form for invoking the ResolveCase operation.
|
Future<ResolveCaseResult> |
resolveCaseAsync(AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
Simplified method form for invoking the ResolveCase operation with an AsyncHandler.
|
Future<ResolveCaseResult> |
resolveCaseAsync(ResolveCaseRequest resolveCaseRequest)
Resolves a support case.
|
Future<ResolveCaseResult> |
resolveCaseAsync(ResolveCaseRequest resolveCaseRequest,
AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
Resolves a support case.
|
addAttachmentsToSet, addCommunicationToCase, createCase, describeAttachment, describeCases, describeCases, describeCommunications, describeCreateCaseOptions, describeServices, describeServices, describeSeverityLevels, describeSeverityLevels, describeSupportedLanguages, describeTrustedAdvisorCheckRefreshStatuses, describeTrustedAdvisorCheckResult, describeTrustedAdvisorChecks, describeTrustedAdvisorCheckSummaries, getCachedResponseMetadata, refreshTrustedAdvisorCheck, resolveCase, resolveCase, setEndpoint, setRegion, shutdown
Future<AddAttachmentsToSetResult> addAttachmentsToSetAsync(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.
addAttachmentsToSetRequest
- Future<AddAttachmentsToSetResult> addAttachmentsToSetAsync(AddAttachmentsToSetRequest addAttachmentsToSetRequest, AsyncHandler<AddAttachmentsToSetRequest,AddAttachmentsToSetResult> asyncHandler)
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.
addAttachmentsToSetRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(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.
addCommunicationToCaseRequest
- Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest, AsyncHandler<AddCommunicationToCaseRequest,AddCommunicationToCaseResult> asyncHandler)
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.
addCommunicationToCaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateCaseResult> createCaseAsync(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.
createCaseRequest
- Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest, AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
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.
createCaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeAttachmentResult> describeAttachmentAsync(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.
describeAttachmentRequest
- Future<DescribeAttachmentResult> describeAttachmentAsync(DescribeAttachmentRequest describeAttachmentRequest, AsyncHandler<DescribeAttachmentRequest,DescribeAttachmentResult> asyncHandler)
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.
describeAttachmentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCasesResult> describeCasesAsync(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.
describeCasesRequest
- Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest describeCasesRequest, AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
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.
describeCasesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCasesResult> describeCasesAsync()
describeCasesAsync(DescribeCasesRequest)
Future<DescribeCasesResult> describeCasesAsync(AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
Future<DescribeCommunicationsResult> describeCommunicationsAsync(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.
describeCommunicationsRequest
- Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest, AsyncHandler<DescribeCommunicationsRequest,DescribeCommunicationsResult> asyncHandler)
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.
describeCommunicationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCreateCaseOptionsResult> describeCreateCaseOptionsAsync(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.
describeCreateCaseOptionsRequest
- Future<DescribeCreateCaseOptionsResult> describeCreateCaseOptionsAsync(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest, AsyncHandler<DescribeCreateCaseOptionsRequest,DescribeCreateCaseOptionsResult> asyncHandler)
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.
describeCreateCaseOptionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeServicesResult> describeServicesAsync(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.
describeServicesRequest
- Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest describeServicesRequest, AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
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.
describeServicesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeServicesResult> describeServicesAsync()
Future<DescribeServicesResult> describeServicesAsync(AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(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.
describeSeverityLevelsRequest
- Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest, AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
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.
describeSeverityLevelsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync()
Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
Future<DescribeSupportedLanguagesResult> describeSupportedLanguagesAsync(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.
describeSupportedLanguagesRequest
- Future<DescribeSupportedLanguagesResult> describeSupportedLanguagesAsync(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest, AsyncHandler<DescribeSupportedLanguagesRequest,DescribeSupportedLanguagesResult> asyncHandler)
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.
describeSupportedLanguagesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(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.
describeTrustedAdvisorCheckRefreshStatusesRequest
- Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest, AsyncHandler<DescribeTrustedAdvisorCheckRefreshStatusesRequest,DescribeTrustedAdvisorCheckRefreshStatusesResult> asyncHandler)
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.
describeTrustedAdvisorCheckRefreshStatusesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(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.
describeTrustedAdvisorCheckResultRequest
- Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest, AsyncHandler<DescribeTrustedAdvisorCheckResultRequest,DescribeTrustedAdvisorCheckResultResult> asyncHandler)
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.
describeTrustedAdvisorCheckResultRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(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.
describeTrustedAdvisorCheckSummariesRequest
- Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest, AsyncHandler<DescribeTrustedAdvisorCheckSummariesRequest,DescribeTrustedAdvisorCheckSummariesResult> asyncHandler)
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.
describeTrustedAdvisorCheckSummariesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(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.
describeTrustedAdvisorChecksRequest
- Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest, AsyncHandler<DescribeTrustedAdvisorChecksRequest,DescribeTrustedAdvisorChecksResult> asyncHandler)
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.
describeTrustedAdvisorChecksRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(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.
refreshTrustedAdvisorCheckRequest
- Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest, AsyncHandler<RefreshTrustedAdvisorCheckRequest,RefreshTrustedAdvisorCheckResult> asyncHandler)
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.
refreshTrustedAdvisorCheckRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResolveCaseResult> resolveCaseAsync(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.
resolveCaseRequest
- Future<ResolveCaseResult> resolveCaseAsync(ResolveCaseRequest resolveCaseRequest, AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
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.
resolveCaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResolveCaseResult> resolveCaseAsync()
resolveCaseAsync(ResolveCaseRequest)
Future<ResolveCaseResult> resolveCaseAsync(AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)