@Generated(value="software.amazon.awssdk:codegen") public interface SupportClient 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.
The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management operations:
Service names, issue categories, and available severity levels. The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.
Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.
The following list describes the operations available from the AWS Support service for Trusted Advisor:
DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
Using the checkId
for a specific check returned by DescribeTrustedAdvisorChecks, you can call
DescribeTrustedAdvisorCheckResult to obtain the results for the check you specified.
DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.
RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.
DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.
For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddAttachmentsToSetResponse |
addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set.
|
default AddAttachmentsToSetResponse |
addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest)
Adds one or more attachments to an attachment set.
|
default AddCommunicationToCaseResponse |
addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case.
|
default AddCommunicationToCaseResponse |
addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)
Adds additional customer communication to an AWS Support case.
|
static SupportClientBuilder |
builder()
Create a builder that can be used to configure and create a
SupportClient . |
static SupportClient |
create()
Create a
SupportClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateCaseResponse |
createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
Creates a new case in the AWS Support Center.
|
default CreateCaseResponse |
createCase(CreateCaseRequest createCaseRequest)
Creates a new case in the AWS Support Center.
|
default DescribeAttachmentResponse |
describeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest)
Returns the attachment that has the specified ID.
|
default DescribeAttachmentResponse |
describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)
Returns the attachment that has the specified ID.
|
default DescribeCasesResponse |
describeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCasesResponse |
describeCases(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCasesIterable |
describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCasesIterable |
describeCasesPaginator(DescribeCasesRequest describeCasesRequest)
Returns a list of cases that you specify by passing one or more case IDs.
|
default DescribeCommunicationsResponse |
describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)
Returns communications (and attachments) for one or more support cases.
|
default DescribeCommunicationsResponse |
describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications (and attachments) for one or more support cases.
|
default DescribeCommunicationsIterable |
describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)
Returns communications (and attachments) for one or more support cases.
|
default DescribeCommunicationsIterable |
describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest)
Returns communications (and attachments) for one or more support cases.
|
default DescribeServicesResponse |
describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Returns the current list of AWS services and a list of service categories that applies to each one.
|
default DescribeServicesResponse |
describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of AWS services and a list of service categories that applies to each one.
|
default DescribeSeverityLevelsResponse |
describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to an AWS Support case.
|
default DescribeSeverityLevelsResponse |
describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to an AWS Support case.
|
default DescribeTrustedAdvisorCheckRefreshStatusesResponse |
describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
|
default DescribeTrustedAdvisorCheckRefreshStatusesResponse |
describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
|
default DescribeTrustedAdvisorCheckResultResponse |
describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest)
Returns the results of the Trusted Advisor check that has the specified check ID.
|
default DescribeTrustedAdvisorCheckResultResponse |
describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
Returns the results of the Trusted Advisor check that has the specified check ID.
|
default DescribeTrustedAdvisorChecksResponse |
describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest)
Returns information about all available Trusted Advisor checks, including name, ID, category, description, and
metadata.
|
default DescribeTrustedAdvisorChecksResponse |
describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available Trusted Advisor checks, including name, ID, category, description, and
metadata.
|
default DescribeTrustedAdvisorCheckSummariesResponse |
describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
|
default DescribeTrustedAdvisorCheckSummariesResponse |
describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
|
default RefreshTrustedAdvisorCheckResponse |
refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)
Requests a refresh of the Trusted Advisor check that has the specified check ID.
|
default RefreshTrustedAdvisorCheckResponse |
refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Requests a refresh of the Trusted Advisor check that has the specified check ID.
|
default ResolveCaseResponse |
resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest)
Takes a
caseId and returns the initial state of the case along with the state of the case after the
call to ResolveCase completed. |
default ResolveCaseResponse |
resolveCase(ResolveCaseRequest resolveCaseRequest)
Takes a
caseId and returns the initial state of the case along with the state of the case after the
call to ResolveCase completed. |
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static SupportClient create()
SupportClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SupportClientBuilder builder()
SupportClient
.default AddAttachmentsToSetResponse addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest) throws InternalServerErrorException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AttachmentSetSizeLimitExceededException, AttachmentLimitExceededException, AwsServiceException, SdkClientException, SupportException
Adds one or more attachments to an attachment set. If an attachmentSetId
is not specified, a new
attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId
is specified, the attachments are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to a case or case communication.
The set is available for one hour after it is created; the expiryTime
returned in the response
indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any
attachment in the set is 5 MB.
addAttachmentsToSetRequest
- InternalServerErrorException
- An internal server error occurred.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.AttachmentSetSizeLimitExceededException
- A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per
attachment.AttachmentLimitExceededException
- The limit for the number of attachment sets created in a short period of time has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddAttachmentsToSetResponse addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest) throws InternalServerErrorException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AttachmentSetSizeLimitExceededException, AttachmentLimitExceededException, AwsServiceException, SdkClientException, SupportException
Adds one or more attachments to an attachment set. If an attachmentSetId
is not specified, a new
attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId
is specified, the attachments are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to a case or case communication.
The set is available for one hour after it is created; the expiryTime
returned in the response
indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any
attachment in the set is 5 MB.
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.InternalServerErrorException
- An internal server error occurred.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.AttachmentSetSizeLimitExceededException
- A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per
attachment.AttachmentLimitExceededException
- The limit for the number of attachment sets created in a short period of time has been exceeded.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddCommunicationToCaseResponse addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Adds additional customer communication to an AWS Support case. You use the caseId
value to identify
the case to add communication to. You can list a set of email addresses to copy on the communication using the
ccEmailAddresses
value. The communicationBody
value contains the text of the
communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
addCommunicationToCaseRequest
- To be written.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AddCommunicationToCaseResponse addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Adds additional customer communication to an AWS Support case. You use the caseId
value to identify
the case to add communication to. You can list a set of email addresses to copy on the communication using the
ccEmailAddresses
value. The communicationBody
value contains the text of the
communication.
The response indicates the success or failure of the request.
This operation implements a subset of the features of the AWS Support Center.
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. To be written.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCaseResponse createCase(CreateCaseRequest createCaseRequest) throws InternalServerErrorException, CaseCreationLimitExceededException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
serviceCode. The code for an AWS service. You obtain the serviceCode
by calling
DescribeServices.
categoryCode. The category for the service defined for the serviceCode
value. You also obtain
the category code for a service by calling DescribeServices. Each AWS service defines its own set of
category codes.
severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
subject. The Subject field on the AWS Support Center Create Case page.
communicationBody. The Description field on the AWS Support Center Create Case page.
attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.
To add additional communication or attachments to an existing case, use AddCommunicationToCase.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.
createCaseRequest
- InternalServerErrorException
- An internal server error occurred.CaseCreationLimitExceededException
- The case creation limit for the account has been exceeded.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest) throws InternalServerErrorException, CaseCreationLimitExceededException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:
issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
serviceCode. The code for an AWS service. You obtain the serviceCode
by calling
DescribeServices.
categoryCode. The category for the service defined for the serviceCode
value. You also obtain
the category code for a service by calling DescribeServices. Each AWS service defines its own set of
category codes.
severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
subject. The Subject field on the AWS Support Center Create Case page.
communicationBody. The Description field on the AWS Support Center Create Case page.
attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.
To add additional communication or attachments to an existing case, use AddCommunicationToCase.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.
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.InternalServerErrorException
- An internal server error occurred.CaseCreationLimitExceededException
- The case creation limit for the account has been exceeded.AttachmentSetIdNotFoundException
- An attachment set with the specified ID could not be found.AttachmentSetExpiredException
- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAttachmentResponse describeAttachment(DescribeAttachmentRequest describeAttachmentRequest) throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
describeAttachmentRequest
- InternalServerErrorException
- An internal server error occurred.DescribeAttachmentLimitExceededException
- The limit for the number of DescribeAttachment requests in a short period of time has been
exceeded.AttachmentIdNotFoundException
- An attachment with the specified ID could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeAttachmentResponse describeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest) throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
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.InternalServerErrorException
- An internal server error occurred.DescribeAttachmentLimitExceededException
- The limit for the number of DescribeAttachment requests in a short period of time has been
exceeded.AttachmentIdNotFoundException
- An attachment with the specified ID could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCasesResponse describeCases(DescribeCasesRequest describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases
by date by setting values for the afterTime
and beforeTime
request parameters. You can
set values for the includeResolvedCases
and includeCommunications
request parameters to
control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by
the CaseDetails
objects.
describeCasesRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCasesResponse describeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases
by date by setting values for the afterTime
and beforeTime
request parameters. You can
set values for the includeResolvedCases
and includeCommunications
request parameters to
control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by
the CaseDetails
objects.
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.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCasesIterable describeCasesPaginator(DescribeCasesRequest describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases
by date by setting values for the afterTime
and beforeTime
request parameters. You can
set values for the includeResolvedCases
and includeCommunications
request parameters to
control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by
the CaseDetails
objects.
This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request); for (software.amazon.awssdk.services.support.model.DescribeCasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)
operation.
describeCasesRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCasesIterable describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases
by date by setting values for the afterTime
and beforeTime
request parameters. You can
set values for the includeResolvedCases
and includeCommunications
request parameters to
control how much information is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by
the CaseDetails
objects.
This is a variant of describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request); for (software.amazon.awssdk.services.support.model.DescribeCasesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request);
responses.iterator().forEachRemaining(....);
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.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCommunicationsResponse describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications (and attachments) for one or more support cases. You can use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to
restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the
result set. Set maxResults
to the number of cases you want displayed on each page, and use
nextToken
to specify the resumption of pagination.
describeCommunicationsRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCommunicationsResponse describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications (and attachments) for one or more support cases. You can use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to
restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the
result set. Set maxResults
to the number of cases you want displayed on each page, and use
nextToken
to specify the resumption of pagination.
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.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCommunicationsIterable describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications (and attachments) for one or more support cases. You can use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to
restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the
result set. Set maxResults
to the number of cases you want displayed on each page, and use
nextToken
to specify the resumption of pagination.
This is a variant of
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client .describeCommunicationsPaginator(request); for (software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation.
describeCommunicationsRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeCommunicationsIterable describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications (and attachments) for one or more support cases. You can use the afterTime
and beforeTime
parameters to filter by date. You can use the caseId
parameter to
restrict the results to a particular case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the
result set. Set maxResults
to the number of cases you want displayed on each page, and use
nextToken
to specify the resumption of pagination.
This is a variant of
describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client .describeCommunicationsPaginator(request); for (software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in the Service and
Category drop-down lists on the AWS Support Center Create Case page. The values in those fields,
however, do not necessarily match the service codes and categories returned by the DescribeServices
request. Always use the service codes and categories obtained programmatically. This practice ensures that you
always have the most recent set of service and category codes.
describeServicesRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in the Service and
Category drop-down lists on the AWS Support Center Create Case page. The values in those fields,
however, do not necessarily match the service codes and categories returned by the DescribeServices
request. Always use the service codes and categories obtained programmatically. This practice ensures that you
always have the most recent set of service and category codes.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSeverityLevelsResponse describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
describeSeverityLevelsRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeSeverityLevelsResponse describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation.
Use of the DescribeTrustedAdvisorCheckRefreshStatuses
operation for these checks causes an
InvalidParameterValue
error.
describeTrustedAdvisorCheckRefreshStatusesRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation.
Use of the DescribeTrustedAdvisorCheckRefreshStatuses
operation for these checks causes an
InvalidParameterValue
error.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
timestamp. The time of the last refresh of the check.
checkId. The unique identifier for the check.
describeTrustedAdvisorCheckResultRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
timestamp. The time of the last refresh of the check.
checkId. The unique identifier for the check.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects.
describeTrustedAdvisorCheckSummariesRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
describeTrustedAdvisorChecksRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the
RefreshTrustedAdvisorCheck
operation for these checks causes an InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
checkId. The unique identifier for the check.
refreshTrustedAdvisorCheckRequest
- InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the
RefreshTrustedAdvisorCheck
operation for these checks causes an InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
checkId. The unique identifier for the check.
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.InternalServerErrorException
- An internal server error occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResolveCaseResponse resolveCase(ResolveCaseRequest resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Takes a caseId
and returns the initial state of the case along with the state of the case after the
call to ResolveCase completed.
resolveCaseRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResolveCaseResponse resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Takes a caseId
and returns the initial state of the case along with the state of the case after the
call to ResolveCase completed.
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.InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested caseId
could not be located.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.