JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.connectcases

Class AmazonConnectCasesClient

  • All Implemented Interfaces:
    AmazonConnectCases
    Direct Known Subclasses:
    AmazonConnectCasesAsyncClient 

    @ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonConnectCasesClient
extends AmazonWebServiceClient
implements AmazonConnectCases
    Client for accessing ConnectCases. All service calls made using this client are blocking, and will not return until the service call completes.

    With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see Amazon Connect Cases in the Amazon Connect Administrator Guide.

    • Method Detail

      • createCase

        public CreateCaseResult createCase(CreateCaseRequest request)

        If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 

          <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul>
        Specified by:
        createCase in interface AmazonConnectCases
        Parameters:
        createCaseRequest -
        Returns:
        Result of the CreateCase operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • createDomain

        public CreateDomainResult createDomain(CreateDomainRequest request)

        Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

        This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases. 

          </important>
        Specified by:
        createDomain in interface AmazonConnectCases
        Parameters:
        createDomainRequest -
        Returns:
        Result of the CreateDomain operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • createField

        public CreateFieldResult createField(CreateFieldRequest request)

        Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

        Specified by:
        createField in interface AmazonConnectCases
        Parameters:
        createFieldRequest -
        Returns:
        Result of the CreateField operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • createLayout

        public CreateLayoutResult createLayout(CreateLayoutRequest request)

        Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

        • Fields to display to the users

        • Field ordering

        Title and Status fields cannot be part of layouts since they are not configurable.

        Specified by:
        createLayout in interface AmazonConnectCases
        Parameters:
        createLayoutRequest -
        Returns:
        Result of the CreateLayout operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • createRelatedItem

        public CreateRelatedItemResult createRelatedItem(CreateRelatedItemRequest request)

        Creates a related item (comments, tasks, and contacts) and associates it with a case.

        • A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a contactArn). All Related Items have their own internal identifier, the relatedItemArn. Examples of related items include comments and contacts.

        • If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide. 

          </note>
        Specified by:
        createRelatedItem in interface AmazonConnectCases
        Parameters:
        createRelatedItemRequest -
        Returns:
        Result of the CreateRelatedItem operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • createTemplate

        public CreateTemplateResult createTemplate(CreateTemplateRequest request)

        Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

        Specified by:
        createTemplate in interface AmazonConnectCases
        Parameters:
        createTemplateRequest -
        Returns:
        Result of the CreateTemplate operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • deleteDomain

        public DeleteDomainResult deleteDomain(DeleteDomainRequest request)

        Deletes a Cases domain. 

          <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note>
        Specified by:
        deleteDomain in interface AmazonConnectCases
        Parameters:
        deleteDomainRequest -
        Returns:
        Result of the DeleteDomain operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • deleteField

        public DeleteFieldResult deleteField(DeleteFieldRequest request)

        Deletes a field from a cases template. You can delete up to 100 fields per domain.

        After a field is deleted:

        • You can still retrieve the field by calling BatchGetField.

        • You cannot update a deleted field by calling UpdateField; it throws a ValidationException.

        • Deleted fields are not included in the ListFields response.

        • Calling CreateCase with a deleted field throws a ValidationException denoting which field IDs in the request have been deleted.

        • Calling GetCase with a deleted field ID returns the deleted field's value if one exists.

        • Calling UpdateCase with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.

        • GetTemplate does not return field IDs for deleted fields.

        • GetLayout does not return field IDs for deleted fields.

        • Calling SearchCases with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.

        • Calling SearchCases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.

        • Calling BatchPutFieldOptions with a deleted field ID throw a ValidationException.

        • Calling GetCaseEventConfiguration does not return field IDs for deleted fields.

        Specified by:
        deleteField in interface AmazonConnectCases
        Parameters:
        deleteFieldRequest -
        Returns:
        Result of the DeleteField operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • deleteLayout

        public DeleteLayoutResult deleteLayout(DeleteLayoutRequest request)

        Deletes a layout from a cases template. You can delete up to 100 layouts per domain. 

          <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul>
        Specified by:
        deleteLayout in interface AmazonConnectCases
        Parameters:
        deleteLayoutRequest -
        Returns:
        Result of the DeleteLayout operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • deleteTemplate

        public DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)

        Deletes a cases template. You can delete up to 100 templates per domain. 

          <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul>
        Specified by:
        deleteTemplate in interface AmazonConnectCases
        Parameters:
        deleteTemplateRequest -
        Returns:
        Result of the DeleteTemplate operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • listLayouts

        public ListLayoutsResult listLayouts(ListLayoutsRequest request)

        Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

        Specified by:
        listLayouts in interface AmazonConnectCases
        Parameters:
        listLayoutsRequest -
        Returns:
        Result of the ListLayouts operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        See Also:
        AWS API Documentation

      • searchCases

        public SearchCasesResult searchCases(SearchCasesRequest request)

        Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

        For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID .

        Specified by:
        searchCases in interface AmazonConnectCases
        Parameters:
        searchCasesRequest -
        Returns:
        Result of the SearchCases operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        See Also:
        AWS API Documentation

      • updateCase

        public UpdateCaseResult updateCase(UpdateCaseRequest request)

        If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 

          <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p>
        Specified by:
        updateCase in interface AmazonConnectCases
        Parameters:
        updateCaseRequest -
        Returns:
        Result of the UpdateCase operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        See Also:
        AWS API Documentation

      • updateField

        public UpdateFieldResult updateField(UpdateFieldRequest request)

        Updates the properties of an existing field.

        Specified by:
        updateField in interface AmazonConnectCases
        Parameters:
        updateFieldRequest -
        Returns:
        Result of the UpdateField operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • updateLayout

        public UpdateLayoutResult updateLayout(UpdateLayoutRequest request)

        Updates the attributes of an existing layout.

        If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

        A ValidationException is returned when you add non-existent fieldIds to a layout.

        Title and Status fields cannot be part of layouts because they are not configurable.

        Specified by:
        updateLayout in interface AmazonConnectCases
        Parameters:
        updateLayoutRequest -
        Returns:
        Result of the UpdateLayout operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        ServiceQuotaExceededException - The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
        See Also:
        AWS API Documentation

      • updateTemplate

        public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)

        Updates the attributes of an existing template. The template attributes that can be modified include name, description, layoutConfiguration, requiredFields, and status. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

        Specified by:
        updateTemplate in interface AmazonConnectCases
        Parameters:
        updateTemplateRequest -
        Returns:
        Result of the UpdateTemplate operation returned by the service.
        Throws:
        InternalServerException - We couldn't process your request because of an issue with the server. Try again later.
        ResourceNotFoundException - We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.
        ValidationException - The request isn't valid. Check the syntax and try again.
        ThrottlingException - The rate has been exceeded for this API. Please try again after a few minutes.
        AccessDeniedException - You do not have sufficient access to perform this action.
        ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
        See Also:
        AWS API Documentation

      • 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 AmazonConnectCases
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.

      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonConnectCases
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /