Interface SupportClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SupportClient extends AwsClient
Service client for accessing AWS Support. This can be created using the staticbuilder()method.Amazon Web Services Support The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
You can manage your support cases with the following Amazon Web Services Support API operations:
-
The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.
-
The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.
-
The DescribeServices and DescribeSeverityLevels operations return Amazon Web Service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.
You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.
For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.
For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddAttachmentsToSetResponseaddAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest)Adds one or more attachments to an attachment set.default AddAttachmentsToSetResponseaddAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest)Adds one or more attachments to an attachment set.default AddCommunicationToCaseResponseaddCommunicationToCase(Consumer<AddCommunicationToCaseRequest.Builder> addCommunicationToCaseRequest)Adds additional customer communication to an Amazon Web Services Support case.default AddCommunicationToCaseResponseaddCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)Adds additional customer communication to an Amazon Web Services Support case.static SupportClientBuilderbuilder()Create a builder that can be used to configure and create aSupportClient.static SupportClientcreate()Create aSupportClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateCaseResponsecreateCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)Creates a case in the Amazon Web Services Support Center.default CreateCaseResponsecreateCase(CreateCaseRequest createCaseRequest)Creates a case in the Amazon Web Services Support Center.default DescribeAttachmentResponsedescribeAttachment(Consumer<DescribeAttachmentRequest.Builder> describeAttachmentRequest)Returns the attachment that has the specified ID.default DescribeAttachmentResponsedescribeAttachment(DescribeAttachmentRequest describeAttachmentRequest)Returns the attachment that has the specified ID.default DescribeCasesResponsedescribeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)Returns a list of cases that you specify by passing one or more case IDs.default DescribeCasesResponsedescribeCases(DescribeCasesRequest describeCasesRequest)Returns a list of cases that you specify by passing one or more case IDs.default DescribeCasesIterabledescribeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest)Returns a list of cases that you specify by passing one or more case IDs.default DescribeCasesIterabledescribeCasesPaginator(DescribeCasesRequest describeCasesRequest)Returns a list of cases that you specify by passing one or more case IDs.default DescribeCommunicationsResponsedescribeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)Returns communications and attachments for one or more support cases.default DescribeCommunicationsResponsedescribeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)Returns communications and attachments for one or more support cases.default DescribeCommunicationsIterabledescribeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest)Returns communications and attachments for one or more support cases.default DescribeCommunicationsIterabledescribeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest)Returns communications and attachments for one or more support cases.default DescribeCreateCaseOptionsResponsedescribeCreateCaseOptions(Consumer<DescribeCreateCaseOptionsRequest.Builder> describeCreateCaseOptionsRequest)Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.default DescribeCreateCaseOptionsResponsedescribeCreateCaseOptions(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest)Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.default DescribeServicesResponsedescribeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)Returns the current list of Amazon Web Services services and a list of service categories for each service.default DescribeServicesResponsedescribeServices(DescribeServicesRequest describeServicesRequest)Returns the current list of Amazon Web Services services and a list of service categories for each service.default DescribeSeverityLevelsResponsedescribeSeverityLevels(Consumer<DescribeSeverityLevelsRequest.Builder> describeSeverityLevelsRequest)Returns the list of severity levels that you can assign to a support case.default DescribeSeverityLevelsResponsedescribeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)Returns the list of severity levels that you can assign to a support case.default DescribeSupportedLanguagesResponsedescribeSupportedLanguages(Consumer<DescribeSupportedLanguagesRequest.Builder> describeSupportedLanguagesRequest)Returns a list of supported languages for a specifiedcategoryCode,issueTypeandserviceCode.default DescribeSupportedLanguagesResponsedescribeSupportedLanguages(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest)Returns a list of supported languages for a specifiedcategoryCode,issueTypeandserviceCode.default DescribeTrustedAdvisorCheckRefreshStatusesResponsedescribeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest)Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.default DescribeTrustedAdvisorCheckRefreshStatusesResponsedescribeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.default DescribeTrustedAdvisorCheckResultResponsedescribeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest)Returns the results of the Trusted Advisor check that has the specified check ID.default DescribeTrustedAdvisorCheckResultResponsedescribeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)Returns the results of the Trusted Advisor check that has the specified check ID.default DescribeTrustedAdvisorChecksResponsedescribeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest)Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.default DescribeTrustedAdvisorChecksResponsedescribeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.default DescribeTrustedAdvisorCheckSummariesResponsedescribeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest)Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.default DescribeTrustedAdvisorCheckSummariesResponsedescribeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.default RefreshTrustedAdvisorCheckResponserefreshTrustedAdvisorCheck(Consumer<RefreshTrustedAdvisorCheckRequest.Builder> refreshTrustedAdvisorCheckRequest)Refreshes the Trusted Advisor check that you specify using the check ID.default RefreshTrustedAdvisorCheckResponserefreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)Refreshes the Trusted Advisor check that you specify using the check ID.default ResolveCaseResponseresolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest)Resolves a support case.default ResolveCaseResponseresolveCase(ResolveCaseRequest resolveCaseRequest)Resolves a support case.default SupportServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
addAttachmentsToSet
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
expiryTimereturned in the response is when the set expires.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
addAttachmentsToSetRequest-- Returns:
- Result of the AddAttachmentsToSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
addAttachmentsToSet
default AddAttachmentsToSetResponse addAttachmentsToSet(Consumer<AddAttachmentsToSetRequest.Builder> addAttachmentsToSetRequest) throws InternalServerErrorException, AttachmentSetIdNotFoundException, AttachmentSetExpiredException, AttachmentSetSizeLimitExceededException, AttachmentLimitExceededException, AwsServiceException, SdkClientException, SupportException
Adds one or more attachments to an attachment set.
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
expiryTimereturned in the response is when the set expires.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaAddAttachmentsToSetRequest.builder()- Parameters:
addAttachmentsToSetRequest- AConsumerthat will call methods onAddAttachmentsToSetRequest.Builderto create a request.- Returns:
- Result of the AddAttachmentsToSet operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
addCommunicationToCase
default 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
caseIdparameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using theccEmailAddressesparameter. ThecommunicationBodyvalue contains the text of the communication.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
addCommunicationToCaseRequest-- Returns:
- Result of the AddCommunicationToCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
addCommunicationToCase
default 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
caseIdparameter to identify the case to which to add communication. You can list a set of email addresses to copy on the communication by using theccEmailAddressesparameter. ThecommunicationBodyvalue contains the text of the communication.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaAddCommunicationToCaseRequest.builder()- Parameters:
addCommunicationToCaseRequest- AConsumerthat will call methods onAddCommunicationToCaseRequest.Builderto create a request.- Returns:
- Result of the AddCommunicationToCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createCase
default 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
CreateCaserequest 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
caseIdis separate from thedisplayIdthat appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get thedisplayId.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
createCaseRequest-- Returns:
- Result of the CreateCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseCreationLimitExceededException- The case creation limit for the account has been exceeded.AttachmentSetIdNotFoundException- An attachment set with the specified ID could not be found.AttachmentSetExpiredException- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createCase
default 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
CreateCaserequest 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
caseIdis separate from thedisplayIdthat appears in the Amazon Web Services Support Center. Use the DescribeCases operation to get thedisplayId.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaCreateCaseRequest.builder()- Parameters:
createCaseRequest- AConsumerthat will call methods onCreateCaseRequest.Builderto create a request.- Returns:
- Result of the CreateCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseCreationLimitExceededException- The case creation limit for the account has been exceeded.AttachmentSetIdNotFoundException- An attachment set with the specified ID could not be found.AttachmentSetExpiredException- The expiration time of the attachment set has passed. The set expires 1 hour after it is created.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAttachment
default 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeAttachmentRequest-- Returns:
- Result of the DescribeAttachment operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.DescribeAttachmentLimitExceededException- The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.AttachmentIdNotFoundException- An attachment with the specified ID could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAttachment
default 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaDescribeAttachmentRequest.builder()- Parameters:
describeAttachmentRequest- AConsumerthat will call methods onDescribeAttachmentRequest.Builderto create a request.- Returns:
- Result of the DescribeAttachment operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.DescribeAttachmentLimitExceededException- The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.AttachmentIdNotFoundException- An attachment with the specified ID could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCases
default DescribeCasesResponse describeCases(DescribeCasesRequest describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTimeandbeforeTimeparameters to filter the cases by date. You can set values for theincludeResolvedCasesandincludeCommunicationsparameters to specify how much information to return.The response returns the following in JSON format:
-
One or more CaseDetails data types.
-
One or more
nextTokenvalues, which specify where to paginate the returned records represented by theCaseDetailsobjects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeCasesRequest-- Returns:
- Result of the DescribeCases operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCases
default DescribeCasesResponse describeCases(Consumer<DescribeCasesRequest.Builder> describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTimeandbeforeTimeparameters to filter the cases by date. You can set values for theincludeResolvedCasesandincludeCommunicationsparameters to specify how much information to return.The response returns the following in JSON format:
-
One or more CaseDetails data types.
-
One or more
nextTokenvalues, which specify where to paginate the returned records represented by theCaseDetailsobjects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaDescribeCasesRequest.builder()- Parameters:
describeCasesRequest- AConsumerthat will call methods onDescribeCasesRequest.Builderto create a request.- Returns:
- Result of the DescribeCases operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCasesPaginator
default DescribeCasesIterable describeCasesPaginator(DescribeCasesRequest describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTimeandbeforeTimeparameters to filter the cases by date. You can set values for theincludeResolvedCasesandincludeCommunicationsparameters to specify how much information to return.The response returns the following in JSON format:
-
One or more CaseDetails data types.
-
One or more
nextTokenvalues, which specify where to paginate the returned records represented by theCaseDetailsobjects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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
2) Using For loopsoftware.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
describeCasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCasesPaginator
default DescribeCasesIterable describeCasesPaginator(Consumer<DescribeCasesRequest.Builder> describeCasesRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns a list of cases that you specify by passing one or more case IDs. You can use the
afterTimeandbeforeTimeparameters to filter the cases by date. You can set values for theincludeResolvedCasesandincludeCommunicationsparameters to specify how much information to return.The response returns the following in JSON format:
-
One or more CaseDetails data types.
-
One or more
nextTokenvalues, which specify where to paginate the returned records represented by theCaseDetailsobjects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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
2) Using For loopsoftware.amazon.awssdk.services.support.paginators.DescribeCasesIterable responses = client.describeCasesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeCasesRequest.builder()- Parameters:
describeCasesRequest- AConsumerthat will call methods onDescribeCasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCommunications
default DescribeCommunicationsResponse describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the
afterTimeandbeforeTimeparameters to filter by date. You can use thecaseIdparameter 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
maxResultsandnextTokenparameters to control the pagination of the results. SetmaxResultsto the number of cases that you want to display on each page, and usenextTokento specify the resumption of pagination.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeCommunicationsRequest-- Returns:
- Result of the DescribeCommunications operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCommunications
default DescribeCommunicationsResponse describeCommunications(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the
afterTimeandbeforeTimeparameters to filter by date. You can use thecaseIdparameter 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
maxResultsandnextTokenparameters to control the pagination of the results. SetmaxResultsto the number of cases that you want to display on each page, and usenextTokento specify the resumption of pagination.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaDescribeCommunicationsRequest.builder()- Parameters:
describeCommunicationsRequest- AConsumerthat will call methods onDescribeCommunicationsRequest.Builderto create a request.- Returns:
- Result of the DescribeCommunications operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCommunicationsPaginator
default DescribeCommunicationsIterable describeCommunicationsPaginator(DescribeCommunicationsRequest describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the
afterTimeandbeforeTimeparameters to filter by date. You can use thecaseIdparameter 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
maxResultsandnextTokenparameters to control the pagination of the results. SetmaxResultsto the number of cases that you want to display on each page, and usenextTokento specify the resumption of pagination.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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
2) Using For loopsoftware.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
describeCommunicationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCommunicationsPaginator
default DescribeCommunicationsIterable describeCommunicationsPaginator(Consumer<DescribeCommunicationsRequest.Builder> describeCommunicationsRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Returns communications and attachments for one or more support cases. Use the
afterTimeandbeforeTimeparameters to filter by date. You can use thecaseIdparameter 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
maxResultsandnextTokenparameters to control the pagination of the results. SetmaxResultsto the number of cases that you want to display on each page, and usenextTokento specify the resumption of pagination.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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
2) Using For loopsoftware.amazon.awssdk.services.support.paginators.DescribeCommunicationsIterable responses = client.describeCommunicationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaDescribeCommunicationsRequest.builder()- Parameters:
describeCommunicationsRequest- AConsumerthat will call methods onDescribeCommunicationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCreateCaseOptions
default DescribeCreateCaseOptionsResponse describeCreateCaseOptions(DescribeCreateCaseOptionsRequest describeCreateCaseOptionsRequest) throws InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, SupportException
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the
languagecategoryCode,issueTypeandserviceCodeused to retrieve the CreateCaseOptions.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeCreateCaseOptionsRequest-- Returns:
- Result of the DescribeCreateCaseOptions operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeCreateCaseOptions
default DescribeCreateCaseOptionsResponse describeCreateCaseOptions(Consumer<DescribeCreateCaseOptionsRequest.Builder> describeCreateCaseOptionsRequest) throws InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, SupportException
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability. You can specify the
languagecategoryCode,issueTypeandserviceCodeused to retrieve the CreateCaseOptions.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
This is a convenience which creates an instance of the
DescribeCreateCaseOptionsRequest.Builderavoiding the need to create one manually viaDescribeCreateCaseOptionsRequest.builder()- Parameters:
describeCreateCaseOptionsRequest- AConsumerthat will call methods onDescribeCreateCaseOptionsRequest.Builderto create a request.- Returns:
- Result of the DescribeCreateCaseOptions operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeServices
default 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
DescribeServicesoperation. Always use the service codes and categories that theDescribeServicesoperation returns, so that you have the most recent set of service and category codes.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeServicesRequest-- Returns:
- Result of the DescribeServices operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeServices
default 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
DescribeServicesoperation. Always use the service codes and categories that theDescribeServicesoperation returns, so that you have the most recent set of service and category codes.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaDescribeServicesRequest.builder()- Parameters:
describeServicesRequest- AConsumerthat will call methods onDescribeServicesRequest.Builderto create a request.- Returns:
- Result of the DescribeServices operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeSeverityLevels
default 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeSeverityLevelsRequest-- Returns:
- Result of the DescribeSeverityLevels operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeSeverityLevels
default 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaDescribeSeverityLevelsRequest.builder()- Parameters:
describeSeverityLevelsRequest- AConsumerthat will call methods onDescribeSeverityLevelsRequest.Builderto create a request.- Returns:
- Result of the DescribeSeverityLevels operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeSupportedLanguages
default DescribeSupportedLanguagesResponse describeSupportedLanguages(DescribeSupportedLanguagesRequest describeSupportedLanguagesRequest) throws InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, SupportException
Returns a list of supported languages for a specified
categoryCode,issueTypeandserviceCode. The returned supported languages will include a ISO 639-1 code for thelanguage, and the language display name.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
describeSupportedLanguagesRequest-- Returns:
- Result of the DescribeSupportedLanguages operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeSupportedLanguages
default DescribeSupportedLanguagesResponse describeSupportedLanguages(Consumer<DescribeSupportedLanguagesRequest.Builder> describeSupportedLanguagesRequest) throws InternalServerErrorException, ThrottlingException, AwsServiceException, SdkClientException, SupportException
Returns a list of supported languages for a specified
categoryCode,issueTypeandserviceCode. The returned supported languages will include a ISO 639-1 code for thelanguage, and the language display name.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
This is a convenience which creates an instance of the
DescribeSupportedLanguagesRequest.Builderavoiding the need to create one manually viaDescribeSupportedLanguagesRequest.builder()- Parameters:
describeSupportedLanguagesRequest- AConsumerthat will call methods onDescribeSupportedLanguagesRequest.Builderto create a request.- Returns:
- Result of the DescribeSupportedLanguages operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckRefreshStatuses
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) throws InternalServerErrorException, ThrottlingException, 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
DescribeTrustedAdvisorCheckRefreshStatusesoperation. If you call this operation for these checks, you might see anInvalidParameterValueerror.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
- Parameters:
describeTrustedAdvisorCheckRefreshStatusesRequest-- Returns:
- Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckRefreshStatuses
default DescribeTrustedAdvisorCheckRefreshStatusesResponse describeTrustedAdvisorCheckRefreshStatuses(Consumer<DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builder> describeTrustedAdvisorCheckRefreshStatusesRequest) throws InternalServerErrorException, ThrottlingException, 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
DescribeTrustedAdvisorCheckRefreshStatusesoperation. If you call this operation for these checks, you might see anInvalidParameterValueerror.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorCheckRefreshStatusesRequest.Builderavoiding the need to create one manually viaDescribeTrustedAdvisorCheckRefreshStatusesRequest.builder()- Parameters:
describeTrustedAdvisorCheckRefreshStatusesRequest- AConsumerthat will call methods onDescribeTrustedAdvisorCheckRefreshStatusesRequest.Builderto create a request.- Returns:
- Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckResult
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) throws InternalServerErrorException, ThrottlingException, 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), ornot_available. -
timestamp - The time of the last refresh of the check.
-
checkId - The unique identifier for the check.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
- Parameters:
describeTrustedAdvisorCheckResultRequest-- Returns:
- Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckResult
default DescribeTrustedAdvisorCheckResultResponse describeTrustedAdvisorCheckResult(Consumer<DescribeTrustedAdvisorCheckResultRequest.Builder> describeTrustedAdvisorCheckResultRequest) throws InternalServerErrorException, ThrottlingException, 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), ornot_available. -
timestamp - The time of the last refresh of the check.
-
checkId - The unique identifier for the check.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorCheckResultRequest.Builderavoiding the need to create one manually viaDescribeTrustedAdvisorCheckResultRequest.builder()- Parameters:
describeTrustedAdvisorCheckResultRequest- AConsumerthat will call methods onDescribeTrustedAdvisorCheckResultRequest.Builderto create a request.- Returns:
- Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckSummaries
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, ThrottlingException, 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
- Parameters:
describeTrustedAdvisorCheckSummariesRequest-- Returns:
- Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorCheckSummaries
default DescribeTrustedAdvisorCheckSummariesResponse describeTrustedAdvisorCheckSummaries(Consumer<DescribeTrustedAdvisorCheckSummariesRequest.Builder> describeTrustedAdvisorCheckSummariesRequest) throws InternalServerErrorException, ThrottlingException, 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 doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorCheckSummariesRequest.Builderavoiding the need to create one manually viaDescribeTrustedAdvisorCheckSummariesRequest.builder()- Parameters:
describeTrustedAdvisorCheckSummariesRequest- AConsumerthat will call methods onDescribeTrustedAdvisorCheckSummariesRequest.Builderto create a request.- Returns:
- Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorChecks
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, ThrottlingException, 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 response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support. -
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
- Parameters:
describeTrustedAdvisorChecksRequest-- Returns:
- Result of the DescribeTrustedAdvisorChecks operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeTrustedAdvisorChecks
default DescribeTrustedAdvisorChecksResponse describeTrustedAdvisorChecks(Consumer<DescribeTrustedAdvisorChecksRequest.Builder> describeTrustedAdvisorChecksRequest) throws InternalServerErrorException, ThrottlingException, 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 response contains a TrustedAdvisorCheckDescription object for each check. You must set the Amazon Web Services Region to us-east-1.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support. -
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
This is a convenience which creates an instance of the
DescribeTrustedAdvisorChecksRequest.Builderavoiding the need to create one manually viaDescribeTrustedAdvisorChecksRequest.builder()- Parameters:
describeTrustedAdvisorChecksRequest- AConsumerthat will call methods onDescribeTrustedAdvisorChecksRequest.Builderto create a request.- Returns:
- Result of the DescribeTrustedAdvisorChecks operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.ThrottlingException- You have exceeded the maximum allowed TPS (Transactions Per Second) for the operations.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
refreshTrustedAdvisorCheck
default 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
RefreshTrustedAdvisorCheckoperation to refresh them, you might see theInvalidParameterValueerror.The response contains a TrustedAdvisorCheckRefreshStatus object.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
- Parameters:
refreshTrustedAdvisorCheckRequest-- Returns:
- Result of the RefreshTrustedAdvisorCheck operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
refreshTrustedAdvisorCheck
default 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
RefreshTrustedAdvisorCheckoperation to refresh them, you might see theInvalidParameterValueerror.The response contains a TrustedAdvisorCheckRefreshStatus object.
-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
To call the Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations. For more information, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.
This is a convenience which creates an instance of the
RefreshTrustedAdvisorCheckRequest.Builderavoiding the need to create one manually viaRefreshTrustedAdvisorCheckRequest.builder()- Parameters:
refreshTrustedAdvisorCheckRequest- AConsumerthat will call methods onRefreshTrustedAdvisorCheckRequest.Builderto create a request.- Returns:
- Result of the RefreshTrustedAdvisorCheck operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.SupportException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
resolveCase
default ResolveCaseResponse resolveCase(ResolveCaseRequest resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Resolves a support case. This operation takes a
caseIdand returns the initial and final state of the case.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror message appears. For information about changing your support plan, see Amazon Web Services Support.
- Parameters:
resolveCaseRequest-- Returns:
- Result of the ResolveCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
resolveCase
default ResolveCaseResponse resolveCase(Consumer<ResolveCaseRequest.Builder> resolveCaseRequest) throws InternalServerErrorException, CaseIdNotFoundException, AwsServiceException, SdkClientException, SupportException
Resolves a support case. This operation takes a
caseIdand returns the initial and final state of the case.-
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
-
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the
SubscriptionRequiredExceptionerror 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.Builderavoiding the need to create one manually viaResolveCaseRequest.builder()- Parameters:
resolveCaseRequest- AConsumerthat will call methods onResolveCaseRequest.Builderto create a request.- Returns:
- Result of the ResolveCase operation returned by the service.
- Throws:
InternalServerErrorException- An internal server error occurred.CaseIdNotFoundException- The requestedcaseIdcouldn'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.AwsServiceException- See Also:
- AWS API Documentation
-
-
create
static SupportClient create()
Create aSupportClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SupportClientBuilder builder()
Create a builder that can be used to configure and create aSupportClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SupportServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-