Class AWSSupportClient

    • Field Detail

      • configFactory

        protected static final ClientConfigurationFactory configFactory
        Client configuration factory providing ClientConfigurations tailored to this client
    • Constructor Detail

      • AWSSupportClient

        public AWSSupportClient()
        Constructs a new client to invoke service methods on AWS Support. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSSupportClient

        public AWSSupportClient​(ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Support. A credentials provider chain will be used that searches for credentials in this order:
        • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
        • Java System Properties - aws.accessKeyId and aws.secretKey
        • Instance profile credentials delivered through the Amazon EC2 metadata service

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
        See Also:
        DefaultAWSCredentialsProviderChain
      • AWSSupportClient

        public AWSSupportClient​(AWSCredentials awsCredentials)
        Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      • AWSSupportClient

        public AWSSupportClient​(AWSCredentials awsCredentials,
                                ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
      • AWSSupportClient

        public AWSSupportClient​(AWSCredentialsProvider awsCredentialsProvider)
        Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      • AWSSupportClient

        public AWSSupportClient​(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration)
        Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider and client configuration options.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
      • AWSSupportClient

        public AWSSupportClient​(AWSCredentialsProvider awsCredentialsProvider,
                                ClientConfiguration clientConfiguration,
                                RequestMetricCollector requestMetricCollector)
        Constructs a new client to invoke service methods on AWS Support using the specified AWS account credentials provider, client configuration options, and request metric collector.

        All service calls made using this new client object are blocking, and will not return until the service call completes.

        Parameters:
        awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
        clientConfiguration - The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc.).
        requestMetricCollector - optional request metric collector
    • Method Detail

      • addAttachmentsToSet

        public AddAttachmentsToSetResult addAttachmentsToSet​(AddAttachmentsToSetRequest addAttachmentsToSetRequest)

        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:
        addAttachmentsToSetRequest -
        Returns:
        Result of the AddAttachmentsToSet operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
        AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
        AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
        AttachmentSetSizeLimitExceededException - A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
        AttachmentLimitExceededException - The limit for the number of attachment sets created in a short period of time has been exceeded.
      • addCommunicationToCase

        public AddCommunicationToCaseResult addCommunicationToCase​(AddCommunicationToCaseRequest addCommunicationToCaseRequest)

        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:
        addCommunicationToCaseRequest - To be written.
        Returns:
        Result of the AddCommunicationToCase operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
        CaseIdNotFoundException - The requested CaseId could not be located.
        AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
        AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • createCase

        public CreateCaseResult createCase​(CreateCaseRequest createCaseRequest)

        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:
        createCaseRequest -
        Returns:
        Result of the CreateCase operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
        CaseCreationLimitExceededException - The case creation limit for the account has been exceeded.
        AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.
        AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.
      • describeCases

        public DescribeCasesResult describeCases​(DescribeCasesRequest describeCasesRequest)

        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:
        describeCasesRequest -
        Returns:
        Result of the DescribeCases operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
        CaseIdNotFoundException - The requested CaseId could not be located.
      • describeCommunications

        public DescribeCommunicationsResult describeCommunications​(DescribeCommunicationsRequest describeCommunicationsRequest)

        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:
        describeCommunicationsRequest -
        Returns:
        Result of the DescribeCommunications operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
        CaseIdNotFoundException - The requested CaseId could not be located.
      • describeServices

        public DescribeServicesResult describeServices​(DescribeServicesRequest describeServicesRequest)

        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:
        describeServicesRequest -
        Returns:
        Result of the DescribeServices operation returned by the service.
        Throws:
        InternalServerErrorException - An internal server error occurred.
      • getCachedResponseMetadata

        public 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. 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 the 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.