@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSupport extends Object implements AWSSupport
AWSSupport
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddAttachmentsToSetResult |
addAttachmentsToSet(AddAttachmentsToSetRequest request)
Adds one or more attachments to an attachment set.
|
AddCommunicationToCaseResult |
addCommunicationToCase(AddCommunicationToCaseRequest request)
Adds additional customer communication to an Amazon Web Services Support case.
|
CreateCaseResult |
createCase(CreateCaseRequest request)
Creates a case in the Amazon Web Services Support Center.
|
DescribeAttachmentResult |
describeAttachment(DescribeAttachmentRequest request)
Returns the attachment that has the specified ID.
|
DescribeCasesResult |
describeCases()
Simplified method form for invoking the DescribeCases operation.
|
DescribeCasesResult |
describeCases(DescribeCasesRequest request)
Returns a list of cases that you specify by passing one or more case IDs.
|
DescribeCommunicationsResult |
describeCommunications(DescribeCommunicationsRequest request)
Returns communications and attachments for one or more support cases.
|
DescribeCreateCaseOptionsResult |
describeCreateCaseOptions(DescribeCreateCaseOptionsRequest request)
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
|
DescribeServicesResult |
describeServices()
Simplified method form for invoking the DescribeServices operation.
|
DescribeServicesResult |
describeServices(DescribeServicesRequest request)
Returns the current list of Amazon Web Services services and a list of service categories for each service.
|
DescribeSeverityLevelsResult |
describeSeverityLevels()
Simplified method form for invoking the DescribeSeverityLevels operation.
|
DescribeSeverityLevelsResult |
describeSeverityLevels(DescribeSeverityLevelsRequest request)
Returns the list of severity levels that you can assign to a support case.
|
DescribeSupportedLanguagesResult |
describeSupportedLanguages(DescribeSupportedLanguagesRequest request)
Returns a list of supported languages for a specified
categoryCode , issueType and
serviceCode . |
DescribeTrustedAdvisorCheckRefreshStatusesResult |
describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
|
DescribeTrustedAdvisorCheckResultResult |
describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest request)
Returns the results of the Trusted Advisor check that has the specified check ID.
|
DescribeTrustedAdvisorChecksResult |
describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest request)
Returns information about all available Trusted Advisor checks, including the name, ID, category, description,
and metadata.
|
DescribeTrustedAdvisorCheckSummariesResult |
describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest request)
Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
RefreshTrustedAdvisorCheckResult |
refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest request)
Refreshes the Trusted Advisor check that you specify using the check ID.
|
ResolveCaseResult |
resolveCase()
Simplified method form for invoking the ResolveCase operation.
|
ResolveCaseResult |
resolveCase(ResolveCaseRequest request)
Resolves a support case.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://support.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSSupport.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public void setEndpoint(String endpoint)
AWSSupport
Callers can pass in just the endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://support.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSSupport
endpoint
- The endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://support.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AWSSupport
AWSSupport.setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSSupport
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest request)
AWSSupport
Adds one or more attachments to an attachment set.
An attachment set is a temporary container for attachments that you add to a case or case communication. The set
is available for 1 hour after it's created. The expiryTime
returned in the response is when the set
expires.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
addAttachmentsToSet
in interface AWSSupport
public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest request)
AWSSupport
Adds additional customer communication to an Amazon Web Services Support case. Use the caseId
parameter to identify the case to which to add communication. You can list a set of email addresses to copy on
the communication by using the ccEmailAddresses
parameter. The communicationBody
value
contains the text of the communication.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
addCommunicationToCase
in interface AWSSupport
public CreateCaseResult createCase(CreateCaseRequest request)
AWSSupport
Creates a case in the Amazon Web Services Support Center. This operation is similar to how you create a case in the Amazon Web Services Support Center Create Case page.
The Amazon Web Services Support API doesn't support requesting service limit increases. You can submit a service limit increase in the following ways:
Submit a request from the Amazon Web Services Support Center Create Case page.
Use the Service Quotas RequestServiceQuotaIncrease operation.
A successful CreateCase
request returns an Amazon Web Services Support case number. You can use the
DescribeCases operation and specify the case number to get existing Amazon Web Services Support cases.
After you create a case, use the AddCommunicationToCase operation to add additional communication or
attachments to an existing case.
The caseId
is separate from the displayId
that appears in the Amazon Web Services Support Center. Use the
DescribeCases operation to get the displayId
.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
createCase
in interface AWSSupport
public DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest request)
AWSSupport
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 SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeAttachment
in interface AWSSupport
public DescribeCasesResult describeCases(DescribeCasesRequest request)
AWSSupport
Returns a list of cases that you specify by passing one or more case IDs. You can use the afterTime
and beforeTime
parameters to filter the cases by date. You can set values for the
includeResolvedCases
and includeCommunications
parameters to specify how much
information to return.
The response returns the following in JSON format:
One or more CaseDetails data types.
One or more nextToken
values, which specify where to paginate the returned records represented by
the CaseDetails
objects.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request might return an error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeCases
in interface AWSSupport
public DescribeCasesResult describeCases()
AWSSupport
describeCases
in interface AWSSupport
AWSSupport.describeCases(DescribeCasesRequest)
public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest request)
AWSSupport
Returns communications and attachments for one or more support cases. Use the afterTime
and
beforeTime
parameters to filter by date. You can use the caseId
parameter to restrict
the results to a specific case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the maxResults
and nextToken
parameters to control the pagination of the
results. Set maxResults
to the number of cases that you want to display on each page, and use
nextToken
to specify the resumption of pagination.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeCommunications
in interface AWSSupport
public DescribeCreateCaseOptionsResult describeCreateCaseOptions(DescribeCreateCaseOptionsRequest request)
AWSSupport
Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.
You can specify the language
categoryCode
, issueType
and
serviceCode
used 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 SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeCreateCaseOptions
in interface AWSSupport
public DescribeServicesResult describeServices(DescribeServicesRequest request)
AWSSupport
Returns the current list of Amazon Web Services services and a list of service categories for each service. You then use service names and categories in your CreateCase requests. Each Amazon Web Services service has its own set of categories.
The service codes and category codes correspond to the values that appear in the Service and
Category lists on the Amazon Web Services Support Center Create Case page. The values in those fields
don't necessarily match the service codes and categories returned by the DescribeServices
operation.
Always use the service codes and categories that the DescribeServices
operation returns, so that you
have the most recent set of service and category codes.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeServices
in interface AWSSupport
public DescribeServicesResult describeServices()
AWSSupport
describeServices
in interface AWSSupport
AWSSupport.describeServices(DescribeServicesRequest)
public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest request)
AWSSupport
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 SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeSeverityLevels
in interface AWSSupport
public DescribeSeverityLevelsResult describeSeverityLevels()
AWSSupport
describeSeverityLevels
in interface AWSSupport
AWSSupport.describeSeverityLevels(DescribeSeverityLevelsRequest)
public DescribeSupportedLanguagesResult describeSupportedLanguages(DescribeSupportedLanguagesRequest request)
AWSSupport
Returns a list of supported languages for a specified categoryCode
, issueType
and
serviceCode
. The returned supported languages will include a ISO 639-1 code for the
language
, 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 SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
describeSupportedLanguages
in interface AWSSupport
public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)
AWSSupport
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically, and you can't return their refresh statuses by using the
DescribeTrustedAdvisorCheckRefreshStatuses
operation. If you call this operation for these checks,
you might see an InvalidParameterValue
error.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
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.
describeTrustedAdvisorCheckRefreshStatuses
in interface AWSSupport
public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest request)
AWSSupport
Returns the results of the Trusted Advisor check that has the specified check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
status - The alert status of the check can be ok
(green), warning
(yellow),
error
(red), or not_available
.
timestamp - The time of the last refresh of the check.
checkId - The unique identifier for the check.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
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.
describeTrustedAdvisorCheckResult
in interface AWSSupport
public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest request)
AWSSupport
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 SubscriptionRequiredException
error 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.
describeTrustedAdvisorCheckSummaries
in interface AWSSupport
public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest request)
AWSSupport
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 SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
The names and descriptions for Trusted Advisor checks are subject to change. We recommend that you specify the check ID in your code to uniquely identify a check.
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.
describeTrustedAdvisorChecks
in interface AWSSupport
public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest request)
AWSSupport
Refreshes the Trusted Advisor check that you specify using the check ID. You can get the check IDs by calling the DescribeTrustedAdvisorChecks operation.
Some checks are refreshed automatically. If you call the RefreshTrustedAdvisorCheck
operation to
refresh them, you might see the InvalidParameterValue
error.
The response contains a TrustedAdvisorCheckRefreshStatus object.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
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.
refreshTrustedAdvisorCheck
in interface AWSSupport
public ResolveCaseResult resolveCase(ResolveCaseRequest request)
AWSSupport
Resolves a support case. This operation takes a caseId
and returns the initial and final state of
the case.
You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.
If you call the Amazon Web Services Support API from an account that doesn't have a Business, Enterprise On-Ramp,
or Enterprise Support plan, the SubscriptionRequiredException
error message appears. For information
about changing your support plan, see Amazon Web Services
Support.
resolveCase
in interface AWSSupport
public ResolveCaseResult resolveCase()
AWSSupport
resolveCase
in interface AWSSupport
AWSSupport.resolveCase(ResolveCaseRequest)
public void shutdown()
AWSSupport
shutdown
in interface AWSSupport
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSupport
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSSupport
request
- The originally executed request.