software.amazon.awssdk.services.support.SupportClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.support;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.support.model.AddAttachmentsToSetRequest;
import software.amazon.awssdk.services.support.model.AddAttachmentsToSetResponse;
import software.amazon.awssdk.services.support.model.AddCommunicationToCaseRequest;
import software.amazon.awssdk.services.support.model.AddCommunicationToCaseResponse;
import software.amazon.awssdk.services.support.model.AttachmentIdNotFoundException;
import software.amazon.awssdk.services.support.model.AttachmentLimitExceededException;
import software.amazon.awssdk.services.support.model.AttachmentSetExpiredException;
import software.amazon.awssdk.services.support.model.AttachmentSetIdNotFoundException;
import software.amazon.awssdk.services.support.model.AttachmentSetSizeLimitExceededException;
import software.amazon.awssdk.services.support.model.CaseCreationLimitExceededException;
import software.amazon.awssdk.services.support.model.CaseIdNotFoundException;
import software.amazon.awssdk.services.support.model.CreateCaseRequest;
import software.amazon.awssdk.services.support.model.CreateCaseResponse;
import software.amazon.awssdk.services.support.model.DescribeAttachmentLimitExceededException;
import software.amazon.awssdk.services.support.model.DescribeAttachmentRequest;
import software.amazon.awssdk.services.support.model.DescribeAttachmentResponse;
import software.amazon.awssdk.services.support.model.DescribeCasesRequest;
import software.amazon.awssdk.services.support.model.DescribeCasesResponse;
import software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest;
import software.amazon.awssdk.services.support.model.DescribeCommunicationsResponse;
import software.amazon.awssdk.services.support.model.DescribeServicesRequest;
import software.amazon.awssdk.services.support.model.DescribeServicesResponse;
import software.amazon.awssdk.services.support.model.DescribeSeverityLevelsRequest;
import software.amazon.awssdk.services.support.model.DescribeSeverityLevelsResponse;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckRefreshStatusesRequest;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckRefreshStatusesResponse;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckResultRequest;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckResultResponse;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckSummariesRequest;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorCheckSummariesResponse;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorChecksRequest;
import software.amazon.awssdk.services.support.model.DescribeTrustedAdvisorChecksResponse;
import software.amazon.awssdk.services.support.model.InternalServerErrorException;
import software.amazon.awssdk.services.support.model.RefreshTrustedAdvisorCheckRequest;
import software.amazon.awssdk.services.support.model.RefreshTrustedAdvisorCheckResponse;
import software.amazon.awssdk.services.support.model.ResolveCaseRequest;
import software.amazon.awssdk.services.support.model.ResolveCaseResponse;
import software.amazon.awssdk.services.support.model.SupportException;
import software.amazon.awssdk.services.support.paginators.DescribeCasesIterable;
import software.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable;
/**
* Service client for accessing AWS Support. This can be created using the static {@link #builder()} method.
*
* AWS Support
*
* The AWS Support API reference is intended for programmers who need detailed information about the AWS Support
* operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP
* methods that return results in JSON format.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support plan,
* see AWS Support.
*
*
*
*
*
* The AWS Support service also exposes a set of AWS
* Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify
* checks to refresh, and get the refresh status of checks.
*
*
* The following list describes the AWS Support case management operations:
*
*
* -
*
* Service names, issue categories, and available severity levels. The DescribeServices and
* DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem
* severity levels. You use these values when you call the CreateCase operation.
*
*
* -
*
* Case creation, case details, and case resolution. The CreateCase, DescribeCases,
* DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about
* cases, and resolve cases.
*
*
* -
*
* Case communication. The DescribeCommunications, AddCommunicationToCase, and
* AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.
*
*
*
*
* The following list describes the operations available from the AWS Support service for Trusted Advisor:
*
*
* -
*
* DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
*
*
* -
*
* Using the checkId for a specific check returned by DescribeTrustedAdvisorChecks, you can call
* DescribeTrustedAdvisorCheckResult to obtain the results for the check that you specified.
*
*
* -
*
* DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.
*
*
* -
*
* RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.
*
*
* -
*
* DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.
*
*
*
*
* For authentication of requests, AWS Support uses Signature Version 4 Signing
* Process.
*
*
* See About the AWS Support API in the
* AWS Support User Guide for information about how to use this service to create and manage your support cases,
* and how to call Trusted Advisor for results of checks on your resources.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface SupportClient extends SdkClient {
String SERVICE_NAME = "support";
/**
* Create a {@link SupportClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static SupportClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SupportClient}.
*/
static SupportClientBuilder builder() {
return new DefaultSupportClientBuilder();
}
/**
*
* Adds one or more attachments to an attachment set.
*
*
* An attachment set is a temporary container for attachments that you add to a case or case communication. The set
* is available for 1 hour after it's created. The expiryTime returned in the response is when the set
* expires.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param addAttachmentsToSetRequest
* @return Result of the AddAttachmentsToSet operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws AttachmentSetSizeLimitExceededException
* A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB
* per attachment.
* @throws AttachmentLimitExceededException
* The limit for the number of attachment sets created in a short period of time has been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.AddAttachmentsToSet
* @see AWS
* API Documentation
*/
default AddAttachmentsToSetResponse addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)
throws InternalServerErrorException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException,
AttachmentSetSizeLimitExceededException, AttachmentLimitExceededException, AwsServiceException, SdkClientException,
SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Adds one or more attachments to an attachment set.
*
*
* An attachment set is a temporary container for attachments that you add to a case or case communication. The set
* is available for 1 hour after it's created. The expiryTime returned in the response is when the set
* expires.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link AddAttachmentsToSetRequest.Builder} avoiding the
* need to create one manually via {@link AddAttachmentsToSetRequest#builder()}
*
*
* @param addAttachmentsToSetRequest
* A {@link Consumer} that will call methods on {@link AddAttachmentsToSetRequest.Builder} to create a
* request.
* @return Result of the AddAttachmentsToSet operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws AttachmentSetSizeLimitExceededException
* A limit for the size of an attachment set has been exceeded. The limits are three attachments and 5 MB
* per attachment.
* @throws AttachmentLimitExceededException
* The limit for the number of attachment sets created in a short period of time has been exceeded.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.AddAttachmentsToSet
* @see AWS
* API Documentation
*/
default AddAttachmentsToSetResponse addAttachmentsToSet(
Consumer addAttachmentsToSetRequest) throws InternalServerErrorException,
AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AttachmentSetSizeLimitExceededException,
AttachmentLimitExceededException, AwsServiceException, SdkClientException, SupportException {
return addAttachmentsToSet(AddAttachmentsToSetRequest.builder().applyMutation(addAttachmentsToSetRequest).build());
}
/**
*
* Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify
* the case to which to add communication. You can list a set of email addresses to copy on the communication by
* using the ccEmailAddresses parameter. The communicationBody value contains the text of
* the communication.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param addCommunicationToCaseRequest
* @return Result of the AddCommunicationToCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.AddCommunicationToCase
* @see AWS
* API Documentation
*/
default AddCommunicationToCaseResponse addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AttachmentSetIdNotFoundException,
AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Adds additional customer communication to an AWS Support case. Use the caseId parameter to identify
* the case to which to add communication. You can list a set of email addresses to copy on the communication by
* using the ccEmailAddresses parameter. The communicationBody value contains the text of
* the communication.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link AddCommunicationToCaseRequest.Builder} avoiding the
* need to create one manually via {@link AddCommunicationToCaseRequest#builder()}
*
*
* @param addCommunicationToCaseRequest
* A {@link Consumer} that will call methods on {@link AddCommunicationToCaseRequest.Builder} to create a
* request.
* @return Result of the AddCommunicationToCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.AddCommunicationToCase
* @see AWS
* API Documentation
*/
default AddCommunicationToCaseResponse addCommunicationToCase(
Consumer addCommunicationToCaseRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AwsServiceException,
SdkClientException, SupportException {
return addCommunicationToCase(AddCommunicationToCaseRequest.builder().applyMutation(addCommunicationToCaseRequest)
.build());
}
/**
*
* Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support
* Center Create Case page.
*
*
* The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase
* in the following ways:
*
*
* -
*
* Submit a request from the AWS Support Center Create Case page.
*
*
* -
*
* Use the Service Quotas RequestServiceQuotaIncrease operation.
*
*
*
*
* A successful CreateCase request returns an AWS Support case number. You can use the
* DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a
* case, use the AddCommunicationToCase operation to add additional communication or attachments to an
* existing case.
*
*
* The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to
* get the displayId.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param createCaseRequest
* @return Result of the CreateCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseCreationLimitExceededException
* The case creation limit for the account has been exceeded.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.CreateCase
* @see AWS API
* Documentation
*/
default CreateCaseResponse createCase(CreateCaseRequest createCaseRequest) throws InternalServerErrorException,
CaseCreationLimitExceededException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException,
AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a case in the AWS Support Center. This operation is similar to how you create a case in the AWS Support
* Center Create Case page.
*
*
* The AWS Support API doesn't support requesting service limit increases. You can submit a service limit increase
* in the following ways:
*
*
* -
*
* Submit a request from the AWS Support Center Create Case page.
*
*
* -
*
* Use the Service Quotas RequestServiceQuotaIncrease operation.
*
*
*
*
* A successful CreateCase request returns an AWS Support case number. You can use the
* DescribeCases operation and specify the case number to get existing AWS Support cases. After you create a
* case, use the AddCommunicationToCase operation to add additional communication or attachments to an
* existing case.
*
*
* The caseId is separate from the displayId that appears in the AWS Support Center. Use the DescribeCases operation to
* get the displayId.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateCaseRequest.Builder} avoiding the need to
* create one manually via {@link CreateCaseRequest#builder()}
*
*
* @param createCaseRequest
* A {@link Consumer} that will call methods on {@link CreateCaseRequest.Builder} to create a request.
* @return Result of the CreateCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseCreationLimitExceededException
* The case creation limit for the account has been exceeded.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.CreateCase
* @see AWS API
* Documentation
*/
default CreateCaseResponse createCase(Consumer createCaseRequest)
throws InternalServerErrorException, CaseCreationLimitExceededException, AttachmentSetIdNotFoundException,
AttachmentSetExpiredException, AwsServiceException, SdkClientException, SupportException {
return createCase(CreateCaseRequest.builder().applyMutation(createCaseRequest).build());
}
/**
*
* Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files
* that describe your issue. Attachment IDs are generated by the case management system when you add an attachment
* to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are
* returned by the DescribeCommunications operation.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeAttachmentRequest
* @return Result of the DescribeAttachment operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws DescribeAttachmentLimitExceededException
* The limit for the number of DescribeAttachment requests in a short period of time has been
* exceeded.
* @throws AttachmentIdNotFoundException
* An attachment with the specified ID could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeAttachment
* @see AWS API
* Documentation
*/
default DescribeAttachmentResponse describeAttachment(DescribeAttachmentRequest describeAttachmentRequest)
throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException,
AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the attachment that has the specified ID. Attachments can include screenshots, error logs, or other files
* that describe your issue. Attachment IDs are generated by the case management system when you add an attachment
* to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are
* returned by the DescribeCommunications operation.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeAttachmentRequest.Builder} avoiding the
* need to create one manually via {@link DescribeAttachmentRequest#builder()}
*
*
* @param describeAttachmentRequest
* A {@link Consumer} that will call methods on {@link DescribeAttachmentRequest.Builder} to create a
* request.
* @return Result of the DescribeAttachment operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws DescribeAttachmentLimitExceededException
* The limit for the number of DescribeAttachment requests in a short period of time has been
* exceeded.
* @throws AttachmentIdNotFoundException
* An attachment with the specified ID could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeAttachment
* @see AWS API
* Documentation
*/
default DescribeAttachmentResponse describeAttachment(Consumer describeAttachmentRequest)
throws InternalServerErrorException, DescribeAttachmentLimitExceededException, AttachmentIdNotFoundException,
AwsServiceException, SdkClientException, SupportException {
return describeAttachment(DescribeAttachmentRequest.builder().applyMutation(describeAttachmentRequest).build());
}
/**
*
* Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
* and beforeTime parameters to filter the cases by date. You can set values for the
* includeResolvedCases and includeCommunications parameters to specify how much
* information to return.
*
*
* The response returns the following in JSON format:
*
*
* -
*
* One or more CaseDetails data
* types.
*
*
* -
*
* One or more nextToken values, which specify where to paginate the returned records represented by
* the CaseDetails objects.
*
*
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request
* might return an error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeCasesRequest
* @return Result of the DescribeCases operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCases
* @see AWS API
* Documentation
*/
default DescribeCasesResponse describeCases(DescribeCasesRequest describeCasesRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
* and beforeTime parameters to filter the cases by date. You can set values for the
* includeResolvedCases and includeCommunications parameters to specify how much
* information to return.
*
*
* The response returns the following in JSON format:
*
*
* -
*
* One or more CaseDetails data
* types.
*
*
* -
*
* One or more nextToken values, which specify where to paginate the returned records represented by
* the CaseDetails objects.
*
*
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request
* might return an error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCasesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeCasesRequest#builder()}
*
*
* @param describeCasesRequest
* A {@link Consumer} that will call methods on {@link DescribeCasesRequest.Builder} to create a request.
* @return Result of the DescribeCases operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCases
* @see AWS API
* Documentation
*/
default DescribeCasesResponse describeCases(Consumer describeCasesRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException,
SupportException {
return describeCases(DescribeCasesRequest.builder().applyMutation(describeCasesRequest).build());
}
/**
*
* Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
* and beforeTime parameters to filter the cases by date. You can set values for the
* includeResolvedCases and includeCommunications parameters to specify how much
* information to return.
*
*
* The response returns the following in JSON format:
*
*
* -
*
* One or more CaseDetails data
* types.
*
*
* -
*
* One or more nextToken values, which specify where to paginate the returned records represented by
* the CaseDetails objects.
*
*
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request
* might return an error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)} operation.
*
*
* @param describeCasesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCases
* @see AWS API
* Documentation
*/
default DescribeCasesIterable describeCasesPaginator(DescribeCasesRequest describeCasesRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException,
SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
* and beforeTime parameters to filter the cases by date. You can set values for the
* includeResolvedCases and includeCommunications parameters to specify how much
* information to return.
*
*
* The response returns the following in JSON format:
*
*
* -
*
* One or more CaseDetails data
* types.
*
*
* -
*
* One or more nextToken values, which specify where to paginate the returned records represented by
* the CaseDetails objects.
*
*
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request
* might return an error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a variant of {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCases(software.amazon.awssdk.services.support.model.DescribeCasesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCasesRequest.Builder} avoiding the need to
* create one manually via {@link DescribeCasesRequest#builder()}
*
*
* @param describeCasesRequest
* A {@link Consumer} that will call methods on {@link DescribeCasesRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCases
* @see AWS API
* Documentation
*/
default DescribeCasesIterable describeCasesPaginator(Consumer describeCasesRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException,
SupportException {
return describeCasesPaginator(DescribeCasesRequest.builder().applyMutation(describeCasesRequest).build());
}
/**
*
* Returns communications and attachments for one or more support cases. Use the afterTime and
* beforeTime parameters to filter by date. You can use the caseId parameter to restrict
* the results to a specific case.
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for
* data might cause an error.
*
*
* You can use the maxResults and nextToken parameters to control the pagination of the
* results. Set maxResults to the number of cases that you want to display on each page, and use
* nextToken to specify the resumption of pagination.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeCommunicationsRequest
* @return Result of the DescribeCommunications operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCommunications
* @see AWS
* API Documentation
*/
default DescribeCommunicationsResponse describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException,
SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns communications and attachments for one or more support cases. Use the afterTime and
* beforeTime parameters to filter by date. You can use the caseId parameter to restrict
* the results to a specific case.
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for
* data might cause an error.
*
*
* You can use the maxResults and nextToken parameters to control the pagination of the
* results. Set maxResults to the number of cases that you want to display on each page, and use
* nextToken to specify the resumption of pagination.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCommunicationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCommunicationsRequest#builder()}
*
*
* @param describeCommunicationsRequest
* A {@link Consumer} that will call methods on {@link DescribeCommunicationsRequest.Builder} to create a
* request.
* @return Result of the DescribeCommunications operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCommunications
* @see AWS
* API Documentation
*/
default DescribeCommunicationsResponse describeCommunications(
Consumer describeCommunicationsRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException {
return describeCommunications(DescribeCommunicationsRequest.builder().applyMutation(describeCommunicationsRequest)
.build());
}
/**
*
* Returns communications and attachments for one or more support cases. Use the afterTime and
* beforeTime parameters to filter by date. You can use the caseId parameter to restrict
* the results to a specific case.
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for
* data might cause an error.
*
*
* You can use the maxResults and nextToken parameters to control the pagination of the
* results. Set maxResults to the number of cases that you want to display on each page, and use
* nextToken to specify the resumption of pagination.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)}
* operation.
*
*
* @param describeCommunicationsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCommunications
* @see AWS
* API Documentation
*/
default DescribeCommunicationsIterable describeCommunicationsPaginator(
DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns communications and attachments for one or more support cases. Use the afterTime and
* beforeTime parameters to filter by date. You can use the caseId parameter to restrict
* the results to a specific case.
*
*
* Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for
* data might cause an error.
*
*
* You can use the maxResults and nextToken parameters to control the pagination of the
* results. Set maxResults to the number of cases that you want to display on each page, and use
* nextToken to specify the resumption of pagination.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCommunications(software.amazon.awssdk.services.support.model.DescribeCommunicationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCommunicationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCommunicationsRequest#builder()}
*
*
* @param describeCommunicationsRequest
* A {@link Consumer} that will call methods on {@link DescribeCommunicationsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeCommunications
* @see AWS
* API Documentation
*/
default DescribeCommunicationsIterable describeCommunicationsPaginator(
Consumer describeCommunicationsRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException {
return describeCommunicationsPaginator(DescribeCommunicationsRequest.builder()
.applyMutation(describeCommunicationsRequest).build());
}
/**
*
* Returns the current list of AWS services and a list of service categories for each service. You then use service
* names and categories in your CreateCase requests. Each AWS service has its own set of categories.
*
*
* The service codes and category codes correspond to the values that appear in the Service and
* Category lists on the AWS Support Center Create Case page. The values in those fields
* don't necessarily match the service codes and categories returned by the DescribeServices operation.
* Always use the service codes and categories that the DescribeServices operation returns, so that you
* have the most recent set of service and category codes.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeServicesRequest
* @return Result of the DescribeServices operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeServices
* @see AWS API
* Documentation
*/
default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the current list of AWS services and a list of service categories for each service. You then use service
* names and categories in your CreateCase requests. Each AWS service has its own set of categories.
*
*
* The service codes and category codes correspond to the values that appear in the Service and
* Category lists on the AWS Support Center Create Case page. The values in those fields
* don't necessarily match the service codes and categories returned by the DescribeServices operation.
* Always use the service codes and categories that the DescribeServices operation returns, so that you
* have the most recent set of service and category codes.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeServicesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeServicesRequest#builder()}
*
*
* @param describeServicesRequest
* A {@link Consumer} that will call methods on {@link DescribeServicesRequest.Builder} to create a request.
* @return Result of the DescribeServices operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeServices
* @see AWS API
* Documentation
*/
default DescribeServicesResponse describeServices(Consumer describeServicesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return describeServices(DescribeServicesRequest.builder().applyMutation(describeServicesRequest).build());
}
/**
*
* Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is
* also a field in the CaseDetails data type that you include for a CreateCase request.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeSeverityLevelsRequest
* @return Result of the DescribeSeverityLevels operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeSeverityLevels
* @see AWS
* API Documentation
*/
default DescribeSeverityLevelsResponse describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is
* also a field in the CaseDetails data type that you include for a CreateCase request.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSeverityLevelsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSeverityLevelsRequest#builder()}
*
*
* @param describeSeverityLevelsRequest
* A {@link Consumer} that will call methods on {@link DescribeSeverityLevelsRequest.Builder} to create a
* request.
* @return Result of the DescribeSeverityLevels operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeSeverityLevels
* @see AWS
* API Documentation
*/
default DescribeSeverityLevelsResponse describeSeverityLevels(
Consumer describeSeverityLevelsRequest) throws InternalServerErrorException,
AwsServiceException, SdkClientException, SupportException {
return describeSeverityLevels(DescribeSeverityLevelsRequest.builder().applyMutation(describeSeverityLevelsRequest)
.build());
}
/**
*
* Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the
* check IDs by calling the DescribeTrustedAdvisorChecks operation.
*
*
* Some checks are refreshed automatically, and you can't return their refresh statuses by using the
* DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
* you might see an InvalidParameterValue error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeTrustedAdvisorCheckRefreshStatusesRequest
* @return Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckRefreshStatuses
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(
DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the refresh status of the AWS Trusted Advisor checks that have the specified check IDs. You can get the
* check IDs by calling the DescribeTrustedAdvisorChecks operation.
*
*
* Some checks are refreshed automatically, and you can't return their refresh statuses by using the
* DescribeTrustedAdvisorCheckRefreshStatuses operation. If you call this operation for these checks,
* you might see an InvalidParameterValue error.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder} avoiding the need to create one manually via
* {@link DescribeTrustedAdvisorCheckRefreshStatusesRequest#builder()}
*
*
* @param describeTrustedAdvisorCheckRefreshStatusesRequest
* A {@link Consumer} that will call methods on
* {@link DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder} to create a request.
* @return Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckRefreshStatuses
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(
Consumer describeTrustedAdvisorCheckRefreshStatusesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest.builder()
.applyMutation(describeTrustedAdvisorCheckRefreshStatusesRequest).build());
}
/**
*
* Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs
* by calling the DescribeTrustedAdvisorChecks operation.
*
*
* The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* In addition, the response contains these fields:
*
*
* -
*
* status - The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
* "not_available".
*
*
* -
*
* timestamp - The time of the last refresh of the check.
*
*
* -
*
* checkId - The unique identifier for the check.
*
*
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeTrustedAdvisorCheckResultRequest
* @return Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckResult
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(
DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the results of the AWS Trusted Advisor check that has the specified check ID. You can get the check IDs
* by calling the DescribeTrustedAdvisorChecks operation.
*
*
* The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* In addition, the response contains these fields:
*
*
* -
*
* status - The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or
* "not_available".
*
*
* -
*
* timestamp - The time of the last refresh of the check.
*
*
* -
*
* checkId - The unique identifier for the check.
*
*
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTrustedAdvisorCheckResultRequest.Builder}
* avoiding the need to create one manually via {@link DescribeTrustedAdvisorCheckResultRequest#builder()}
*
*
* @param describeTrustedAdvisorCheckResultRequest
* A {@link Consumer} that will call methods on {@link DescribeTrustedAdvisorCheckResultRequest.Builder} to
* create a request.
* @return Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckResult
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(
Consumer describeTrustedAdvisorCheckResultRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest.builder()
.applyMutation(describeTrustedAdvisorCheckResultRequest).build());
}
/**
*
* Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get
* the check IDs by calling the DescribeTrustedAdvisorChecks operation.
*
*
* The response contains an array of TrustedAdvisorCheckSummary objects.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeTrustedAdvisorCheckSummariesRequest
* @return Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckSummaries
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(
DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the results for the AWS Trusted Advisor check summaries for the check IDs that you specified. You can get
* the check IDs by calling the DescribeTrustedAdvisorChecks operation.
*
*
* The response contains an array of TrustedAdvisorCheckSummary objects.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeTrustedAdvisorCheckSummariesRequest.Builder} avoiding the need to create one manually via
* {@link DescribeTrustedAdvisorCheckSummariesRequest#builder()}
*
*
* @param describeTrustedAdvisorCheckSummariesRequest
* A {@link Consumer} that will call methods on {@link DescribeTrustedAdvisorCheckSummariesRequest.Builder}
* to create a request.
* @return Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorCheckSummaries
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(
Consumer describeTrustedAdvisorCheckSummariesRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest.builder()
.applyMutation(describeTrustedAdvisorCheckSummariesRequest).build());
}
/**
*
* Returns information about all available AWS Trusted Advisor checks, including the name, ID, category,
* description, and metadata. You must specify a language code. The AWS Support API currently supports English
* ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check.
* You must set the AWS Region to us-east-1.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param describeTrustedAdvisorChecksRequest
* @return Result of the DescribeTrustedAdvisorChecks operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorChecks
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(
DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) throws InternalServerErrorException,
AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about all available AWS Trusted Advisor checks, including the name, ID, category,
* description, and metadata. You must specify a language code. The AWS Support API currently supports English
* ("en") and Japanese ("ja"). The response contains a TrustedAdvisorCheckDescription object for each check.
* You must set the AWS Region to us-east-1.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DescribeTrustedAdvisorChecksRequest.Builder}
* avoiding the need to create one manually via {@link DescribeTrustedAdvisorChecksRequest#builder()}
*
*
* @param describeTrustedAdvisorChecksRequest
* A {@link Consumer} that will call methods on {@link DescribeTrustedAdvisorChecksRequest.Builder} to create
* a request.
* @return Result of the DescribeTrustedAdvisorChecks operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.DescribeTrustedAdvisorChecks
* @see AWS API Documentation
*/
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(
Consumer describeTrustedAdvisorChecksRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest.builder()
.applyMutation(describeTrustedAdvisorChecksRequest).build());
}
/**
*
* Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling
* the DescribeTrustedAdvisorChecks operation.
*
*
*
* Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
* refresh them, you might see the InvalidParameterValue error.
*
*
*
* The response contains a TrustedAdvisorCheckRefreshStatus object.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param refreshTrustedAdvisorCheckRequest
* @return Result of the RefreshTrustedAdvisorCheck operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.RefreshTrustedAdvisorCheck
* @see AWS API Documentation
*/
default RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(
RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest) throws InternalServerErrorException,
AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Refreshes the AWS Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling
* the DescribeTrustedAdvisorChecks operation.
*
*
*
* Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck operation to
* refresh them, you might see the InvalidParameterValue error.
*
*
*
* The response contains a TrustedAdvisorCheckRefreshStatus object.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link RefreshTrustedAdvisorCheckRequest.Builder} avoiding
* the need to create one manually via {@link RefreshTrustedAdvisorCheckRequest#builder()}
*
*
* @param refreshTrustedAdvisorCheckRequest
* A {@link Consumer} that will call methods on {@link RefreshTrustedAdvisorCheckRequest.Builder} to create a
* request.
* @return Result of the RefreshTrustedAdvisorCheck operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.RefreshTrustedAdvisorCheck
* @see AWS API Documentation
*/
default RefreshTrustedAdvisorCheckResponse refreshTrustedAdvisorCheck(
Consumer refreshTrustedAdvisorCheckRequest)
throws InternalServerErrorException, AwsServiceException, SdkClientException, SupportException {
return refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest.builder()
.applyMutation(refreshTrustedAdvisorCheckRequest).build());
}
/**
*
* Resolves a support case. This operation takes a caseId and returns the initial and final state of
* the case.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* @param resolveCaseRequest
* @return Result of the ResolveCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.ResolveCase
* @see AWS API
* Documentation
*/
default ResolveCaseResponse resolveCase(ResolveCaseRequest resolveCaseRequest) throws InternalServerErrorException,
CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException {
throw new UnsupportedOperationException();
}
/**
*
* Resolves a support case. This operation takes a caseId and returns the initial and final state of
* the case.
*
*
*
* -
*
* You must have a Business or Enterprise support plan to use the AWS Support API.
*
*
* -
*
* If you call the AWS Support API from an account that does not have a Business or Enterprise support plan, the
* SubscriptionRequiredException error message appears. For information about changing your support
* plan, see AWS Support.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ResolveCaseRequest.Builder} avoiding the need to
* create one manually via {@link ResolveCaseRequest#builder()}
*
*
* @param resolveCaseRequest
* A {@link Consumer} that will call methods on {@link ResolveCaseRequest.Builder} to create a request.
* @return Result of the ResolveCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested caseId could not be located.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SupportException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SupportClient.ResolveCase
* @see AWS API
* Documentation
*/
default ResolveCaseResponse resolveCase(Consumer resolveCaseRequest)
throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException,
SupportException {
return resolveCase(ResolveCaseRequest.builder().applyMutation(resolveCaseRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("support");
}
}