com.amazonaws.services.support.AWSSupport Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 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 AWS Support.
*
* AWS Support
*
* The AWS Support API reference is intended for programmers who need detailed
* information about the AWS Support operations and data types. This service
* enables you to manage your AWS Support cases programmatically. It uses HTTP
* methods that return results in JSON format.
*
*
* 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 operations:
*
*
* - Service names, issue categories, and available severity levels.
* The DescribeServices and DescribeSeverityLevels operations
* return AWS service names, service codes, service categories, and problem
* severity levels. You use these values when you call the CreateCase
* operation.
* - Case creation, case details, and case resolution. The
* CreateCase, DescribeCases, DescribeAttachment, and
* ResolveCase operations create AWS Support cases, retrieve information
* about cases, and resolve cases.
* - Case communication. The DescribeCommunications,
* AddCommunicationToCase, and AddAttachmentsToSet operations
* retrieve and add communications and attachments to AWS Support cases.
*
*
* The following list describes the operations available from the AWS Support
* service for Trusted Advisor:
*
*
* - DescribeTrustedAdvisorChecks returns the list of checks that run
* against your AWS resources.
* - Using the
CheckId for a specific check returned by
* DescribeTrustedAdvisorChecks, you can call
* DescribeTrustedAdvisorCheckResult to obtain the results for the check
* you specified.
* - DescribeTrustedAdvisorCheckSummaries returns summarized results
* for one or more Trusted Advisor checks.
* - RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a
* specified check.
* - DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh
* status of one or more checks.
*
*
* For authentication of requests, AWS Support uses Signature Version 4 Signing Process.
*
*
* See About
* the AWS Support API in the AWS Support User Guide for information
* about how to use this service to create and manage your support cases, and
* how to call Trusted Advisor for results of checks on your resources.
*
*/
public interface AWSSupport {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "support";
/**
* Overrides the default endpoint for this client
* ("https://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: "https://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:
* "https://support.us-east-1.amazonaws.com") of the region specific
* AWS endpoint this client will communicate with.
*/
void setEndpoint(String endpoint);
/**
* 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. Must not be null and must be a region
* where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Adds one or more attachments to an attachment set. If an
* AttachmentSetId is not specified, a new attachment set is
* created, and the ID of the set is returned in the response. If an
* AttachmentSetId is specified, the attachments are added to
* the specified set, if it exists.
*
*
* An attachment set is a temporary container for attachments that are to be
* added to a case or case communication. The set is available for one hour
* after it is created; the ExpiryTime returned in the response
* indicates when the set expires. The maximum number of attachments in a
* set is 3, and the maximum size of any attachment in the set is 5 MB.
*
*
* @param addAttachmentsToSetRequest
* @return Result of the AddAttachmentsToSet operation returned by the
* service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set
* expires 1 hour after it is created.
* @throws AttachmentSetSizeLimitExceededException
* A limit for the size of an attachment set has been exceeded. The
* limits are 3 attachments and 5 MB per attachment.
* @throws AttachmentLimitExceededException
* The limit for the number of attachment sets created in a short
* period of time has been exceeded.
* @sample AWSSupport.AddAttachmentsToSet
*/
AddAttachmentsToSetResult addAttachmentsToSet(
AddAttachmentsToSetRequest addAttachmentsToSetRequest);
/**
*
* 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 features of the AWS Support
* Center.
*
*
* @param addCommunicationToCaseRequest
* To be written.
* @return Result of the AddCommunicationToCase operation returned by the
* service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested CaseId could not be located.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set
* expires 1 hour after it is created.
* @sample AWSSupport.AddCommunicationToCase
*/
AddCommunicationToCaseResult addCommunicationToCase(
AddCommunicationToCaseRequest addCommunicationToCaseRequest);
/**
*
* Creates a new case in the AWS Support Center. This operation is modeled
* on the behavior of the AWS Support Center Create
* Case page. Its parameters require you to specify the following
* information:
*
*
* - 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."
* - 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 Create
* Case page.
* - CommunicationBody. The Description field on the AWS
* Support Center Create
* Case page.
* - AttachmentSetId. The ID of a set of attachments that has been
* created by using AddAttachmentsToSet.
* - 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 Create
* 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.
*
*
*
* To add additional communication or attachments to an existing case, use
* AddCommunicationToCase.
*
*
*
* A successful CreateCase request returns an AWS Support case
* number. Case numbers are used by the DescribeCases operation to
* retrieve existing AWS Support cases.
*
*
* @param createCaseRequest
* @return Result of the CreateCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseCreationLimitExceededException
* The case creation limit for the account has been exceeded.
* @throws AttachmentSetIdNotFoundException
* An attachment set with the specified ID could not be found.
* @throws AttachmentSetExpiredException
* The expiration time of the attachment set has passed. The set
* expires 1 hour after it is created.
* @sample AWSSupport.CreateCase
*/
CreateCaseResult createCase(CreateCaseRequest createCaseRequest);
/**
*
* Returns the attachment that has the specified ID. 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.
*
*
* @param describeAttachmentRequest
* @return Result of the DescribeAttachment operation returned by the
* service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws DescribeAttachmentLimitExceededException
* The limit for the number of DescribeAttachment requests in
* a short period of time has been exceeded.
* @throws AttachmentIdNotFoundException
* An attachment with the specified ID could not be found.
* @sample AWSSupport.DescribeAttachment
*/
DescribeAttachmentResult describeAttachment(
DescribeAttachmentRequest describeAttachmentRequest);
/**
*
* 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.
* You can set values for the IncludeResolvedCases and
* IncludeCommunications request parameters to control how much
* information is returned.
*
*
* 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.
*
*
* 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
* @return Result of the DescribeCases operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested CaseId could not be located.
* @sample AWSSupport.DescribeCases
*/
DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest);
/**
* Simplified method form for invoking the DescribeCases operation.
*
* @see #describeCases(DescribeCasesRequest)
*/
DescribeCasesResult describeCases();
/**
*
* Returns communications (and attachments) for one or more support cases.
* You can use the AfterTime and BeforeTime
* parameters to filter by date. You can use the CaseId
* parameter to restrict the results to a particular 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 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
* @return Result of the DescribeCommunications operation returned by the
* service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested CaseId could not be located.
* @sample AWSSupport.DescribeCommunications
*/
DescribeCommunicationsResult describeCommunications(
DescribeCommunicationsRequest describeCommunicationsRequest);
/**
*
* 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 Create
* 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
* @return Result of the DescribeServices operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeServices
*/
DescribeServicesResult describeServices(
DescribeServicesRequest describeServicesRequest);
/**
* Simplified method form for invoking the DescribeServices operation.
*
* @see #describeServices(DescribeServicesRequest)
*/
DescribeServicesResult describeServices();
/**
*
* 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
* @return Result of the DescribeSeverityLevels operation returned by the
* service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeSeverityLevels
*/
DescribeSeverityLevelsResult describeSeverityLevels(
DescribeSeverityLevelsRequest describeSeverityLevelsRequest);
/**
* Simplified method form for invoking the DescribeSeverityLevels operation.
*
* @see #describeSeverityLevels(DescribeSeverityLevelsRequest)
*/
DescribeSeverityLevelsResult describeSeverityLevels();
/**
*
* 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
* @return Result of the DescribeTrustedAdvisorCheckRefreshStatuses
* operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeTrustedAdvisorCheckRefreshStatuses
*/
DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(
DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest);
/**
*
* 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
* @return Result of the DescribeTrustedAdvisorCheckResult operation
* returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeTrustedAdvisorCheckResult
*/
DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(
DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest);
/**
*
* 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
* @return Result of the DescribeTrustedAdvisorCheckSummaries operation
* returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeTrustedAdvisorCheckSummaries
*/
DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(
DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest);
/**
*
* 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
* @return Result of the DescribeTrustedAdvisorChecks operation returned by
* the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.DescribeTrustedAdvisorChecks
*/
DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(
DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest);
/**
*
* 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 TrustedAdvisorCheckRefreshStatus 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
* @return Result of the RefreshTrustedAdvisorCheck operation returned by
* the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @sample AWSSupport.RefreshTrustedAdvisorCheck
*/
RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(
RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest);
/**
*
* 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
* @return Result of the ResolveCase operation returned by the service.
* @throws InternalServerErrorException
* An internal server error occurred.
* @throws CaseIdNotFoundException
* The requested CaseId could not be located.
* @sample AWSSupport.ResolveCase
*/
ResolveCaseResult resolveCase(ResolveCaseRequest resolveCaseRequest);
/**
* Simplified method form for invoking the ResolveCase operation.
*
* @see #resolveCase(ResolveCaseRequest)
*/
ResolveCaseResult resolveCase();
/**
* 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.
*/
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.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}