Class AbstractAWSSupport

java.lang.Object
com.amazonaws.services.support.AbstractAWSSupport
All Implemented Interfaces:
AWSSupport
Direct Known Subclasses:
AbstractAWSSupportAsync
public class AbstractAWSSupport extends Object implements AWSSupport
Abstract implementation of AWSSupport. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

  • Constructor Details

    • AbstractAWSSupport

      protected AbstractAWSSupport()

  • Method Details

    • setEndpoint

      public void setEndpoint(String endpoint)
      Description copied from interface: AWSSupport
      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 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.

      Specified by:
      setEndpoint in interface AWSSupport
      Parameters:
      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.

    • setRegion

      public void setRegion(Region region)
      Description copied from interface: AWSSupport
      An alternative to 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.

      Specified by:
      setRegion in interface AWSSupport
      Parameters:
      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.
      See Also:

    • addAttachmentsToSet

      public AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      addAttachmentsToSet in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the AddAttachmentsToSet operation returned by the service.

    • addCommunicationToCase

      public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      addCommunicationToCase in interface AWSSupport
      Parameters:
      request - To be written.
      Returns:
      Result of the AddCommunicationToCase operation returned by the service.

    • createCase

      public CreateCaseResult createCase(CreateCaseRequest request)
      Description copied from interface: AWSSupport

      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:

      1. 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."
      2. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
      3. 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.
      4. 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.
      5. Subject. The Subject field on the AWS Support Center Create Case page.
      6. CommunicationBody. The Description field on the AWS Support Center Create Case page.
      7. AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
      8. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
      9. 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.

      Specified by:
      createCase in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the CreateCase operation returned by the service.

    • describeAttachment

      public DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeAttachment in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeAttachment operation returned by the service.

    • describeCases

      public DescribeCasesResult describeCases(DescribeCasesRequest request)
      Description copied from interface: AWSSupport

      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:

      1. One or more CaseDetails data types.
      2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.
      Specified by:
      describeCases in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeCases operation returned by the service.

    • describeCases

      public DescribeCasesResult describeCases()
      Description copied from interface: AWSSupport
      Simplified method form for invoking the DescribeCases operation.
      Specified by:
      describeCases in interface AWSSupport
      See Also:

    • describeCommunications

      public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeCommunications in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeCommunications operation returned by the service.

    • describeServices

      public DescribeServicesResult describeServices(DescribeServicesRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeServices in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeServices operation returned by the service.

    • describeServices

      public DescribeServicesResult describeServices()
      Description copied from interface: AWSSupport
      Simplified method form for invoking the DescribeServices operation.
      Specified by:
      describeServices in interface AWSSupport
      See Also:

    • describeSeverityLevels

      public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeSeverityLevels in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeSeverityLevels operation returned by the service.

    • describeSeverityLevels

      public DescribeSeverityLevelsResult describeSeverityLevels()
      Description copied from interface: AWSSupport
      Simplified method form for invoking the DescribeSeverityLevels operation.
      Specified by:
      describeSeverityLevels in interface AWSSupport
      See Also:

    • describeTrustedAdvisorCheckRefreshStatuses

      public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)
      Description copied from interface: AWSSupport

      Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

      Specified by:
      describeTrustedAdvisorCheckRefreshStatuses in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.

    • describeTrustedAdvisorCheckResult

      public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest request)
      Description copied from interface: AWSSupport

      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:

      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.
      Specified by:
      describeTrustedAdvisorCheckResult in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.

    • describeTrustedAdvisorCheckSummaries

      public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeTrustedAdvisorCheckSummaries in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.

    • describeTrustedAdvisorChecks

      public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest request)
      Description copied from interface: AWSSupport

      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.

      Specified by:
      describeTrustedAdvisorChecks in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the DescribeTrustedAdvisorChecks operation returned by the service.

    • refreshTrustedAdvisorCheck

      public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest request)
      Description copied from interface: AWSSupport

      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.
      Specified by:
      refreshTrustedAdvisorCheck in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the RefreshTrustedAdvisorCheck operation returned by the service.

    • resolveCase

      public ResolveCaseResult resolveCase(ResolveCaseRequest request)
      Description copied from interface: AWSSupport

      Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

      Specified by:
      resolveCase in interface AWSSupport
      Parameters:
      request -
      Returns:
      Result of the ResolveCase operation returned by the service.

    • resolveCase

      public ResolveCaseResult resolveCase()
      Description copied from interface: AWSSupport
      Simplified method form for invoking the ResolveCase operation.
      Specified by:
      resolveCase in interface AWSSupport
      See Also:

    • shutdown

      public void shutdown()
      Description copied from interface: AWSSupport
      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.
      Specified by:
      shutdown in interface AWSSupport

    • getCachedResponseMetadata

      public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      Description copied from interface: AWSSupport
      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.

      Specified by:
      getCachedResponseMetadata in interface AWSSupport
      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.