@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SupportAsyncClient extends SdkClient
builder()
method.
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.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support plan,
see AWS Support.
The AWS Support service also exposes a set of AWS Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management operations:
Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.
Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.
The following list describes the operations available from the AWS Support service for Trusted Advisor:
DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks, you can call
DescribeTrustedAdvisorCheckResult to obtain the results for the check that you specified.
DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.
RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.
DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.
For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddAttachmentsToSetResponse> |
addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set.
|
default CompletableFuture<AddAttachmentsToSetResponse> |
addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set.
|
default CompletableFuture<AddCommunicationToCaseResponse> |
addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case.
|
default CompletableFuture<AddCommunicationToCaseResponse> |
addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case.
|
static SupportAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SupportAsyncClient. |
static SupportAsyncClient |
create()
Create a
SupportAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateCaseResponse> |
createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
Creates a case in the AWS Support Center.
|
default CompletableFuture<CreateCaseResponse> |
createCase(CreateCaseRequest createCaseRequest)
Creates a case in the AWS Support Center.
|
default CompletableFuture<DescribeAttachmentResponse> |
describeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest)
Returns the attachment that has the specified ID.
|
default CompletableFuture<DescribeAttachmentResponse> |
describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)
Returns the attachment that has the specified ID.
|
default CompletableFuture<DescribeCasesResponse> |
describeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default CompletableFuture<DescribeCasesResponse> |
describeCases(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCasesPublisher |
describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCasesPublisher |
describeCasesPaginator(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default CompletableFuture<DescribeCommunicationsResponse> |
describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)
Returns communications and attachments for one or more support cases.
|
default CompletableFuture<DescribeCommunicationsResponse> |
describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications and attachments for one or more support cases.
|
default DescribeCommunicationsPublisher |
describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)
Returns communications and attachments for one or more support cases.
|
default DescribeCommunicationsPublisher |
describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications and attachments for one or more support cases.
|
default CompletableFuture<DescribeServicesResponse> |
describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Returns the current list of AWS services and a list of service categories for each service.
|
default CompletableFuture<DescribeServicesResponse> |
describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of AWS services and a list of service categories for each service.
|
default CompletableFuture<DescribeSeverityLevelsResponse> |
describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to an AWS Support case.
|
default CompletableFuture<DescribeSeverityLevelsResponse> |
describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to an AWS Support case.
|
default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> |
describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.
|
default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> |
describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs.
|
default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> |
describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest)
Returns the results of the AWS Trusted Advisor check that has the specified check ID.
|
default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> |
describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
Returns the results of the AWS Trusted Advisor check that has the specified check ID.
|
default CompletableFuture<DescribeTrustedAdvisorChecksResponse> |
describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category,
description, and metadata.
|
default CompletableFuture<DescribeTrustedAdvisorChecksResponse> |
describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category,
description, and metadata.
|
default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> |
describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.
|
default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> |
describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified.
|
default CompletableFuture<RefreshTrustedAdvisorCheckResponse> |
refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)
Refreshes the AWS Trusted Advisor check that you specify using the check ID.
|
default CompletableFuture<RefreshTrustedAdvisorCheckResponse> |
refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Refreshes the AWS Trusted Advisor check that you specify using the check ID.
|
default CompletableFuture<ResolveCaseResponse> |
resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest)
Resolves a support case.
|
default CompletableFuture<ResolveCaseResponse> |
resolveCase(ResolveCaseRequest resolveCaseRequest)
Resolves a support case.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SupportAsyncClient create()
SupportAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SupportAsyncClientBuilder builder()
SupportAsyncClient.default CompletableFuture<AddAttachmentsToSetResponse> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
addAttachmentsToSetRequest - default CompletableFuture<AddAttachmentsToSetResponse> addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the AddAttachmentsToSetRequest.Builder avoiding the
need to create one manually via AddAttachmentsToSetRequest.builder()
addAttachmentsToSetRequest - A Consumer that will call methods on AddAttachmentsToSetRequest.Builder to create a
request.default CompletableFuture<AddCommunicationToCaseResponse> addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify
the case to which to add communication. You can list a set of email addresses to copy on the communication by
using the ccEmailAddresses parameter. The communicationBody value contains the text of
the communication.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
addCommunicationToCaseRequest - caseId could not be located.default CompletableFuture<AddCommunicationToCaseResponse> addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify
the case to which to add communication. You can list a set of email addresses to copy on the communication by
using the ccEmailAddresses parameter. The communicationBody value contains the text of
the communication.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the AddCommunicationToCaseRequest.Builder avoiding the
need to create one manually via AddCommunicationToCaseRequest.builder()
addCommunicationToCaseRequest - A Consumer that will call methods on AddCommunicationToCaseRequest.Builder to create a
request.caseId could not be located.default CompletableFuture<CreateCaseResponse> createCase(CreateCaseRequest createCaseRequest)
Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page.
The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the AWS Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase request returns an AWS Support case number. You can use the
DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a
case, use the AddCommunicationToCase operation to add additional communication or attachments to an
existing case.
The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to
get the displayId.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
createCaseRequest - default CompletableFuture<CreateCaseResponse> createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support Center Create Case page.
The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the AWS Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase request returns an AWS Support case number. You can use the
DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a
case, use the AddCommunicationToCase operation to add additional communication or attachments to an
existing case.
The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to
get the displayId.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the CreateCaseRequest.Builder avoiding the need to
create one manually via CreateCaseRequest.builder()
createCaseRequest - A Consumer that will call methods on CreateCaseRequest.Builder to create a request.default CompletableFuture<DescribeAttachmentResponse> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeAttachmentRequest - default CompletableFuture<DescribeAttachmentResponse> describeAttachment(Consumer<DescribeAttachmentRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeAttachmentRequest.Builder avoiding the
need to create one manually via DescribeAttachmentRequest.builder()
describeAttachmentRequest - A Consumer that will call methods on DescribeAttachmentRequest.Builder to create a
request.default CompletableFuture<DescribeCasesResponse> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeCasesRequest - caseId could not be located.default CompletableFuture<DescribeCasesResponse> describeCases(Consumer<DescribeCasesRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeCasesRequest.Builder avoiding the need to
create one manually via DescribeCasesRequest.builder()
describeCasesRequest - A Consumer that will call methods on DescribeCasesRequest.Builder to create a request.caseId could not be located.default DescribeCasesPublisher describeCasesPaginator(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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.support.model.DescribeCasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) operation.
describeCasesRequest - caseId could not be located.default DescribeCasesPublisher describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.support.paginators.DescribeCasesPublisher publisher = client.describeCasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.support.model.DescribeCasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest) operation.
This is a convenience which creates an instance of the DescribeCasesRequest.Builder avoiding the need to
create one manually via DescribeCasesRequest.builder()
describeCasesRequest - A Consumer that will call methods on DescribeCasesRequest.Builder to create a request.caseId could not be located.default CompletableFuture<DescribeCommunicationsResponse> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeCommunicationsRequest - caseId could not be located.default CompletableFuture<DescribeCommunicationsResponse> describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeCommunicationsRequest.Builder avoiding the
need to create one manually via DescribeCommunicationsRequest.builder()
describeCommunicationsRequest - A Consumer that will call methods on DescribeCommunicationsRequest.Builder to create a
request.caseId could not be located.default DescribeCommunicationsPublisher describeCommunicationsPaginator(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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a variant of
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation.
describeCommunicationsRequest - caseId could not be located.default DescribeCommunicationsPublisher describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a variant of
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsPublisher publisher = client.describeCommunicationsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation.
This is a convenience which creates an instance of the DescribeCommunicationsRequest.Builder avoiding the
need to create one manually via DescribeCommunicationsRequest.builder()
describeCommunicationsRequest - A Consumer that will call methods on DescribeCommunicationsRequest.Builder to create a
request.caseId could not be located.default CompletableFuture<DescribeServicesResponse> describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of AWS services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and
Category lists on the AWS Support Center Create Case page. The values in those fields
don't necessarily match the service codes and categories returned by the DescribeServices operation.
Always use the service codes and categories that the DescribeServices operation returns, so that you
have the most recent set of service and category codes.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeServicesRequest - default CompletableFuture<DescribeServicesResponse> describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Returns the current list of AWS services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and
Category lists on the AWS Support Center Create Case page. The values in those fields
don't necessarily match the service codes and categories returned by the DescribeServices operation.
Always use the service codes and categories that the DescribeServices operation returns, so that you
have the most recent set of service and category codes.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeServicesRequest.Builder avoiding the need
to create one manually via DescribeServicesRequest.builder()
describeServicesRequest - A Consumer that will call methods on DescribeServicesRequest.Builder to create a request.default CompletableFuture<DescribeSeverityLevelsResponse> 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 that you include for a CreateCase request.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeSeverityLevelsRequest - default CompletableFuture<DescribeSeverityLevelsResponse> describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> 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 that you include for a CreateCase request.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeSeverityLevelsRequest.Builder avoiding the
need to create one manually via DescribeSeverityLevelsRequest.builder()
describeSeverityLevelsRequest - A Consumer that will call methods on DescribeSeverityLevelsRequest.Builder to create a
request.default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the
DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
you might see an InvalidParameterValue error.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeTrustedAdvisorCheckRefreshStatusesRequest - default CompletableFuture<DescribeTrustedAdvisorCheckRefreshStatusesResponse> describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the
DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
you might see an InvalidParameterValue error.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder avoiding the need to create one manually via
DescribeTrustedAdvisorCheckRefreshStatusesRequest.builder()
describeTrustedAdvisorCheckRefreshStatusesRequest - A Consumer that will call methods on
DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder to create a request.default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeTrustedAdvisorCheckResultRequest - default CompletableFuture<DescribeTrustedAdvisorCheckResultResponse> describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest)
Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeTrustedAdvisorCheckResultRequest.Builder
avoiding the need to create one manually via DescribeTrustedAdvisorCheckResultRequest.builder()
describeTrustedAdvisorCheckResultRequest - A Consumer that will call methods on DescribeTrustedAdvisorCheckResultRequest.Builder to
create a request.default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeTrustedAdvisorCheckSummariesRequest - default CompletableFuture<DescribeTrustedAdvisorCheckSummariesResponse> describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorCheckSummariesRequest.Builder avoiding the need to create one manually via
DescribeTrustedAdvisorCheckSummariesRequest.builder()
describeTrustedAdvisorCheckSummariesRequest - A Consumer that will call methods on DescribeTrustedAdvisorCheckSummariesRequest.Builder
to create a request.default CompletableFuture<DescribeTrustedAdvisorChecksResponse> describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The AWS Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
describeTrustedAdvisorChecksRequest - default CompletableFuture<DescribeTrustedAdvisorChecksResponse> describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest)
Returns information about all available AWS Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The AWS Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the AWS Region to us-east-1.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the DescribeTrustedAdvisorChecksRequest.Builder
avoiding the need to create one manually via DescribeTrustedAdvisorChecksRequest.builder()
describeTrustedAdvisorChecksRequest - A Consumer that will call methods on DescribeTrustedAdvisorChecksRequest.Builder to create
a request.default CompletableFuture<RefreshTrustedAdvisorCheckResponse> refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
refreshTrustedAdvisorCheckRequest - default CompletableFuture<RefreshTrustedAdvisorCheckResponse> refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)
Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the RefreshTrustedAdvisorCheckRequest.Builder avoiding
the need to create one manually via RefreshTrustedAdvisorCheckRequest.builder()
refreshTrustedAdvisorCheckRequest - A Consumer that will call methods on RefreshTrustedAdvisorCheckRequest.Builder to create a
request.default CompletableFuture<ResolveCaseResponse> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
resolveCaseRequest - caseId could not be located.default CompletableFuture<ResolveCaseResponse> resolveCase(Consumer<ResolveCaseRequest.Builder> 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 or Enterprise support plan to use the AWS Support API.
If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
SubscriptionRequiredException error message appears. For information about changing your support
plan, see AWS Support.
This is a convenience which creates an instance of the ResolveCaseRequest.Builder avoiding the need to
create one manually via ResolveCaseRequest.builder()
resolveCaseRequest - A Consumer that will call methods on ResolveCaseRequest.Builder to create a request.caseId could not be located.Copyright © 2021. All rights reserved.