com.amazonaws.services.support.AWSSupport Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.support;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.support.model.*;
/**
* Interface for accessing AWSSupport.
* AWS Support
* The AWS Support API reference is intended for programmers who need
* detailed information about the AWS Support actions and data types.
* This service enables you to manage your AWS Support cases
* programmatically. It uses HTTP methods that return results in JSON
* format.
*
*
* The AWS Support service also exposes a set of
* Trusted Advisor
* features. You can retrieve a list of checks and their descriptions,
* get check results, specify checks to refresh, and get the refresh
* status of checks.
*
*
* The following list describes the AWS Support case management actions:
*
*
*
* - Service names, issue categories, and available severity
* levels. The actions DescribeServices and DescribeSeverityLevels
* enable you to obtain AWS service names, service codes, service
* categories, and problem severity levels. You use these values when you
* call the CreateCase action.
* - Case creation, case details, and case resolution. The
* actions CreateCase, DescribeCases, and ResolveCase enable you to
* create AWS Support cases, retrieve them, and resolve them.
* - Case communication. The actions DescribeCommunications
* and AddCommunicationToCase enable you to retrieve and add
* communication to AWS Support cases.
*
*
*
* The following list describes the actions available from the AWS
* Support service for Trusted Advisor:
*
*
*
* - DescribeTrustedAdvisorChecks returns the list of checks that run
* against your AWS resources.
* - Using the CheckId for a specific check returned by
* DescribeTrustedAdvisorChecks, you can call
* DescribeTrustedAdvisorCheckResult to obtain the results for the check
* you specified.
* - DescribeTrustedAdvisorCheckSummaries returns summarized results
* for one or more Trusted Advisor checks.
* - RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a
* specified check.
* - DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh
* status of one or more checks.
*
*
*
* For authentication of requests, AWS Support uses
* Signature Version 4 Signing Process
* .
*
*
* See the AWS Support
* User Guide
* for information about how to use this service to create and manage
* your support cases, and how to call Trusted Advisor for results of
* checks on your resources.
*
*/
public interface AWSSupport {
/**
* Overrides the default endpoint for this client ("support.us-east-1.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "support.us-east-1.amazonaws.com") or a full
* URL, including the protocol (ex: "support.us-east-1.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link 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:
*
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
*
* 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.
*
* @param endpoint
* The endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL,
* including the protocol (ex: "support.us-east-1.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link 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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* Returns a list of cases that you specify by passing one or more case
* IDs. In addition, you can filter the cases by date by setting values
* for the AfterTime and BeforeTime request
* parameters.
*
*
* 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.
*
*
* @param describeCasesRequest Container for the necessary parameters to
* execute the DescribeCases service method on AWSSupport.
*
* @return The response from the DescribeCases service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the refresh status of the Trusted Advisor checks that have the
* specified check IDs. Check IDs can be obtained by calling
* DescribeTrustedAdvisorChecks.
*
*
* @param describeTrustedAdvisorCheckRefreshStatusesRequest Container for
* the necessary parameters to execute the
* DescribeTrustedAdvisorCheckRefreshStatuses service method on
* AWSSupport.
*
* @return The response from the
* DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the list of severity levels that you can assign to an AWS
* Support case. The severity level for a case is also a field in the
* CaseDetails data type included in any CreateCase request.
*
*
* @param describeSeverityLevelsRequest Container for the necessary
* parameters to execute the DescribeSeverityLevels service method on
* AWSSupport.
*
* @return The response from the DescribeSeverityLevels service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns communications regarding the support case. You can use the
* AfterTime and BeforeTime parameters to
* filter by date. The CaseId parameter enables you to
* identify a specific case by its CaseId value.
*
*
* The MaxResults and NextToken parameters
* enable you to control the pagination of the result set. Set
* MaxResults to the number of cases you want displayed on
* each page, and use NextToken to specify the resumption of
* pagination.
*
*
* @param describeCommunicationsRequest Container for the necessary
* parameters to execute the DescribeCommunications service method on
* AWSSupport.
*
* @return The response from the DescribeCommunications service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Adds additional customer communication to an AWS Support case. You use
* the CaseId value to identify the case to add
* communication to. You can list a set of email addresses to copy on the
* communication using the CcEmailAddresses value. The
* CommunicationBody value contains the text of the
* communication.
*
*
* The response indicates the success or failure of the request.
*
*
* This operation implements a subset of the behavior on the AWS Support
* Your Support Cases
* web form.
*
*
* @param addCommunicationToCaseRequest Container for the necessary
* parameters to execute the AddCommunicationToCase service method on
* AWSSupport.
*
* @return The response from the AddCommunicationToCase service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Creates a new case in the AWS Support Center. This operation is
* modeled on the behavior of the AWS Support Center
* Open a new case
* page. Its parameters require you to specify the following
* information:
*
* - ServiceCode. The code for an AWS service. You obtain
* the
ServiceCode by calling DescribeServices.
* - CategoryCode. The category for the service defined for
* the
ServiceCode value. You also obtain the category code
* for a service by calling DescribeServices. Each AWS service defines
* its own set of category codes.
* - SeverityCode. A value that indicates the urgency of the
* case, which in turn determines the response time according to your
* service level agreement with AWS Support. You obtain the SeverityCode
* by calling DescribeSeverityLevels.
* - Subject. The Subject field on the AWS Support
* Center
* Open a new case
* page.
* - CommunicationBody. The Description field on the
* AWS Support Center
* Open a new case
* page.
* - Language. The human language in which AWS Support handles
* the case. English and Japanese are currently supported.
* - CcEmailAddresses. The AWS Support Center CC field
* on the
* Open a new case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK
* .
* - IssueType. The type of issue for the case. You can
* specify either "customer-service" or "technical." If you do not
* indicate a value, the default is "technical."
*
* NOTE: The AWS Support API does not currently support the
* ability to add attachments to cases. You can, however, call
* AddCommunicationToCase to add information to an open case.
*
*
* A successful CreateCase request returns an AWS Support case number.
* Case numbers are used by the DescribeCases action to retrieve existing
* AWS Support cases.
*
*
* @param createCaseRequest Container for the necessary parameters to
* execute the CreateCase service method on AWSSupport.
*
* @return The response from the CreateCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseCreationLimitExceededException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns information about all available Trusted Advisor checks,
* including name, ID, category, description, and metadata. You must
* specify a language code; English ("en") and Japanese ("ja") are
* currently supported. The response contains a
* TrustedAdvisorCheckDescription for each check.
*
*
* @param describeTrustedAdvisorChecksRequest Container for the necessary
* parameters to execute the DescribeTrustedAdvisorChecks service method
* on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorChecks service
* method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the results of the Trusted Advisor check that has the
* specified check ID. Check IDs can be obtained by calling
* DescribeTrustedAdvisorChecks.
*
*
* The response contains a TrustedAdvisorCheckResult object, which
* contains these three objects:
*
*
*
* - TrustedAdvisorCategorySpecificSummary
* - TrustedAdvisorResourceDetail
* - TrustedAdvisorResourcesSummary
*
*
*
* In addition, the response contains these fields:
*
*
*
* - Status. The alert status of the check: "ok" (green),
* "warning" (yellow), "error" (red), or "not_available".
* - Timestamp. The time of the last refresh of the
* check.
* - CheckId. The unique identifier for the check.
*
*
*
* @param describeTrustedAdvisorCheckResultRequest Container for the
* necessary parameters to execute the DescribeTrustedAdvisorCheckResult
* service method on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorCheckResult
* service method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Takes a CaseId and returns the initial state of the case
* along with the state of the case after the call to ResolveCase
* completed.
*
*
* @param resolveCaseRequest Container for the necessary parameters to
* execute the ResolveCase service method on AWSSupport.
*
* @return The response from the ResolveCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ResolveCaseResult resolveCase(ResolveCaseRequest resolveCaseRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Requests a refresh of the Trusted Advisor check that has the specified
* check ID. Check IDs can be obtained by calling
* DescribeTrustedAdvisorChecks.
*
*
* The response contains a RefreshTrustedAdvisorCheckResult object, which
* contains these fields:
*
*
*
* - Status. The refresh status of the check: "none",
* "enqueued", "processing", "success", or "abandoned".
* - MillisUntilNextRefreshable. The amount of time, in
* milliseconds, until the check is eligible for refresh.
* - CheckId. The unique identifier for the check.
*
*
*
* @param refreshTrustedAdvisorCheckRequest Container for the necessary
* parameters to execute the RefreshTrustedAdvisorCheck service method on
* AWSSupport.
*
* @return The response from the RefreshTrustedAdvisorCheck service
* method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the current list of AWS services and a list of service
* categories that applies to each one. You then use service names and
* categories in your CreateCase requests. Each AWS service has its own
* set of categories.
*
*
* The service codes and category codes correspond to the values that are
* displayed in the Service and Category drop-down lists on
* the AWS Support Center
* Open a new case
* page. The values in those fields, however, do not necessarily match
* the service codes and categories returned by the
* DescribeServices request. Always use the service codes
* and categories obtained programmatically. This practice ensures that
* you always have the most recent set of service and category codes.
*
*
* @param describeServicesRequest Container for the necessary parameters
* to execute the DescribeServices service method on AWSSupport.
*
* @return The response from the DescribeServices service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the summaries of the results of the Trusted Advisor checks
* that have the specified check IDs. Check IDs can be obtained by
* calling DescribeTrustedAdvisorChecks.
*
*
* The response contains an array of TrustedAdvisorCheckSummary objects.
*
*
* @param describeTrustedAdvisorCheckSummariesRequest Container for the
* necessary parameters to execute the
* DescribeTrustedAdvisorCheckSummaries service method on AWSSupport.
*
* @return The response from the DescribeTrustedAdvisorCheckSummaries
* service method, as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of cases that you specify by passing one or more case
* IDs. In addition, you can filter the cases by date by setting values
* for the AfterTime and BeforeTime request
* parameters.
*
*
* 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.
*
*
* @return The response from the DescribeCases service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeCasesResult describeCases() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the list of severity levels that you can assign to an AWS
* Support case. The severity level for a case is also a field in the
* CaseDetails data type included in any CreateCase request.
*
*
* @return The response from the DescribeSeverityLevels service method,
* as returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeSeverityLevelsResult describeSeverityLevels() throws AmazonServiceException, AmazonClientException;
/**
*
* Takes a CaseId and returns the initial state of the case
* along with the state of the case after the call to ResolveCase
* completed.
*
*
* @return The response from the ResolveCase service method, as returned
* by AWSSupport.
*
* @throws InternalServerErrorException
* @throws CaseIdNotFoundException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public ResolveCaseResult resolveCase() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns the current list of AWS services and a list of service
* categories that applies to each one. You then use service names and
* categories in your CreateCase requests. Each AWS service has its own
* set of categories.
*
*
* The service codes and category codes correspond to the values that are
* displayed in the Service and Category drop-down lists on
* the AWS Support Center
* Open a new case
* page. The values in those fields, however, do not necessarily match
* the service codes and categories returned by the
* DescribeServices request. Always use the service codes
* and categories obtained programmatically. This practice ensures that
* you always have the most recent set of service and category codes.
*
*
* @return The response from the DescribeServices service method, as
* returned by AWSSupport.
*
* @throws InternalServerErrorException
*
* @throws AmazonClientException
* If any internal errors are encountered inside the client while
* attempting to make the request or handle the response. For example
* if a network connection is not available.
* @throws AmazonServiceException
* If an error response is returned by AWSSupport indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeServicesResult describeServices() throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for
* debugging issues where a service isn't acting as expected. This data isn't considered part
* of the result data returned by an operation, so it's available through this separate,
* diagnostic interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}