@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SupportClient extends SdkClient
builder() method.
The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or
Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about
changing your support plan, see Amazon Web Services Support.
The Amazon Web Services 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 Amazon Web Services Support case management operations:
Service names, issue categories, and available severity levels - The DescribeServices and DescribeSeverityLevels operations return Amazon Web Services 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 Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
Case communication - The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:
DescribeTrustedAdvisorChecks returns the list of checks that run against your Amazon Web Services 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, Amazon Web Services Support uses Signature Version 4 Signing Process.
See About the Amazon Web Services Support API in the Amazon Web Services 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 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 Amazon Web Services Support case.
|
default AddCommunicationToCaseResponse |
addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)
Adds additional customer communication to an Amazon Web Services 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 case in the Amazon Web Services Support Center.
|
default CreateCaseResponse |
createCase(CreateCaseRequest createCaseRequest)
Creates a case in the Amazon Web Services 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 Amazon Web Services services and a list of service categories for each service.
|
default DescribeServicesResponse |
describeServices(DescribeServicesRequest describeServicesRequest)
Returns the current list of Amazon Web Services services and a list of service categories for each service.
|
default DescribeSeverityLevelsResponse |
describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to a support case.
|
default DescribeSeverityLevelsResponse |
describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
Returns the list of severity levels that you can assign to a 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 the name, ID, category, description,
and metadata.
|
default DescribeTrustedAdvisorChecksResponse |
describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
Returns information about all available Trusted Advisor checks, including the name, ID, category, description,
and metadata.
|
default DescribeTrustedAdvisorCheckSummariesResponse |
describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
|
default DescribeTrustedAdvisorCheckSummariesResponse |
describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
|
default RefreshTrustedAdvisorCheckResponse |
refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)
Refreshes the Trusted Advisor check that you specify using the check ID.
|
default RefreshTrustedAdvisorCheckResponse |
refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
Refreshes the Trusted Advisor check that you specify using the check ID.
|
default ResolveCaseResponse |
resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest)
Resolves a support case.
|
default ResolveCaseResponse |
resolveCase(ResolveCaseRequest resolveCaseRequest)
Resolves a support case.
|
static ServiceMetadata |
serviceMetadata() |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set
is available for 1 hour after it's created. The expiryTime returned in the response is when the set
expires.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
addAttachmentsToSetRequest - InternalServerErrorException - An internal server error occurred.AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.AttachmentSetSizeLimitExceededException - A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB
per attachment.AttachmentLimitExceededException - The limit for the number of attachment sets created in a short period of time has been exceeded.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.AwsServiceExceptiondefault AddAttachmentsToSetResponse addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest) throws InternalServerErrorException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AttachmentSetSizeLimitExceededException, AttachmentLimitExceededException, AwsServiceException, SdkClientException, SupportException
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set
is available for 1 hour after it's created. The expiryTime returned in the response is when the set
expires.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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 three attachments and 5 MB
per attachment.AttachmentLimitExceededException - The limit for the number of attachment sets created in a short period of time has been exceeded.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.AwsServiceExceptiondefault AddCommunicationToCaseResponse addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId
parameter to identify the case to which to add communication. You can list a set of email addresses to copy on
the communication by using the ccEmailAddresses parameter. The communicationBody value
contains the text of the communication.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
addCommunicationToCaseRequest - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't be located.AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.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.AwsServiceExceptiondefault AddCommunicationToCaseResponse addCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId
parameter to identify the case to which to add communication. You can list a set of email addresses to copy on
the communication by using the ccEmailAddresses parameter. The communicationBody value
contains the text of the communication.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't be located.AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.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.AwsServiceExceptiondefault CreateCaseResponse createCase(CreateCaseRequest createCaseRequest) throws InternalServerErrorException, CaseCreationLimitExceededException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase request returns an Amazon Web Services Support case number. You can use the
DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases.
After you create a case, use the AddCommunicationToCase operation to add additional communication or
attachments to an existing case.
The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the
DescribeCases operation to get the displayId.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
createCaseRequest - 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.AwsServiceExceptiondefault CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest) throws InternalServerErrorException, CaseCreationLimitExceededException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase request returns an Amazon Web Services Support case number. You can use the
DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases.
After you create a case, use the AddCommunicationToCase operation to add additional communication or
attachments to an existing case.
The caseId is separate from the displayId that appears in the Amazon Web Services Support Center. Use the
DescribeCases operation to get the displayId.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeAttachmentResponse describeAttachment(DescribeAttachmentRequest describeAttachmentRequest) throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
describeAttachmentRequest - 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.AwsServiceExceptiondefault DescribeAttachmentResponse describeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest) throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files that describe your issue. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault 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. You can use the afterTime
and beforeTime parameters to filter the cases by date. You can set values for the
includeResolvedCases and includeCommunications parameters to specify how much
information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken values, which specify where to paginate the returned records represented by
the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
describeCasesRequest - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault 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. You can use the afterTime
and beforeTime parameters to filter the cases by date. You can set values for the
includeResolvedCases and includeCommunications parameters to specify how much
information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken values, which specify where to paginate the returned records represented by
the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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 couldn't 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.AwsServiceExceptiondefault 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. You can use the afterTime
and beforeTime parameters to filter the cases by date. You can set values for the
includeResolvedCases and includeCommunications parameters to specify how much
information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken values, which specify where to paginate the returned records represented by
the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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(....);
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 - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault 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. You can use the afterTime
and beforeTime parameters to filter the cases by date. You can set values for the
includeResolvedCases and includeCommunications parameters to specify how much
information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken values, which specify where to paginate the returned records represented by
the CaseDetails objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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(....);
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.InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault DescribeCommunicationsResponse describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the afterTime and
beforeTime parameters to filter by date. You can use the caseId parameter to restrict
the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination of the
results. Set maxResults to the number of cases that you want to display on each page, and use
nextToken to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
describeCommunicationsRequest - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault DescribeCommunicationsResponse describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the afterTime and
beforeTime parameters to filter by date. You can use the caseId parameter to restrict
the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination of the
results. Set maxResults to the number of cases that you want to display on each page, and use
nextToken to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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 couldn't 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.AwsServiceExceptiondefault DescribeCommunicationsIterable describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the afterTime and
beforeTime parameters to filter by date. You can use the caseId parameter to restrict
the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination of the
results. Set maxResults to the number of cases that you want to display on each page, and use
nextToken to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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(....);
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 - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault DescribeCommunicationsIterable describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the afterTime and
beforeTime parameters to filter by date. You can use the caseId parameter to restrict
the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults and nextToken parameters to control the pagination of the
results. Set maxResults to the number of cases that you want to display on each page, and use
nextToken to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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(....);
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.InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and
Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields
don't necessarily match the service codes and categories returned by the DescribeServices operation.
Always use the service codes and categories that the DescribeServices operation returns, so that you
have the most recent set of service and category codes.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
describeServicesRequest - 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.AwsServiceExceptiondefault DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and
Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields
don't necessarily match the service codes and categories returned by the DescribeServices operation.
Always use the service codes and categories that the DescribeServices operation returns, so that you
have the most recent set of service and category codes.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeSeverityLevelsResponse describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
describeSeverityLevelsRequest - 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.AwsServiceExceptiondefault DescribeSeverityLevelsResponse describeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the list of severity levels that you can assign to a support case. The severity level for a case is also a field in the CaseDetails data type that you include for a CreateCase request.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the
DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
you might see an InvalidParameterValue error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault 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. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the
DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
you might see an InvalidParameterValue error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check can be ok (green), warning (yellow),
error (red), or not_available.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault 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. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check can be ok (green), warning (yellow),
error (red), or not_available.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains an array of TrustedAdvisorCheckSummary objects.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
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.AwsServiceExceptiondefault DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata. You must specify a language code. The Amazon Web Services Support API currently supports English ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
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.AwsServiceExceptiondefault RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
refresh them, you might see the InvalidParameterValue error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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.AwsServiceExceptiondefault ResolveCaseResponse resolveCase(ResolveCaseRequest resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Resolves a support case. This operation takes a caseId and returns the initial and final state of
the case.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
resolveCaseRequest - InternalServerErrorException - An internal server error occurred.CaseIdNotFoundException - The requested caseId couldn't 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.AwsServiceExceptiondefault ResolveCaseResponse resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Resolves a support case. This operation takes a caseId and returns the initial and final state of
the case.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise
On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For
information about changing your support plan, see Amazon Web
Services Support.
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 couldn't 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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.