AmazonConnectCases (AWS SDK for Java

All Known Subinterfaces:

AmazonConnectCasesAsync

All Known Implementing Classes:

AbstractAmazonConnectCases, AbstractAmazonConnectCasesAsync, AmazonConnectCasesAsyncClient, AmazonConnectCasesClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectCases
```
Interface for accessing ConnectCases.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonConnectCases instead.

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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchGetFieldResult`	`batchGetField(BatchGetFieldRequest batchGetFieldRequest)` Returns the description for the list of fields in the request parameters.
`BatchPutFieldOptionsResult`	`batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)` Creates and updates a set of field options for a single select field in a Cases domain.
`CreateCaseResult`	`createCase(CreateCaseRequest createCaseRequest)` Creates a case in the specified Cases domain.
`CreateDomainResult`	`createDomain(CreateDomainRequest createDomainRequest)` Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
`CreateFieldResult`	`createField(CreateFieldRequest createFieldRequest)` Creates a field in the Cases domain.
`CreateLayoutResult`	`createLayout(CreateLayoutRequest createLayoutRequest)` Creates a layout in the Cases domain.
`CreateRelatedItemResult`	`createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest)` Creates a related item (comments, tasks, and contacts) and associates it with a case.
`CreateTemplateResult`	`createTemplate(CreateTemplateRequest createTemplateRequest)` Creates a template in the Cases domain.
`DeleteDomainResult`	`deleteDomain(DeleteDomainRequest deleteDomainRequest)` Deletes a domain.
`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.
`GetCaseResult`	`getCase(GetCaseRequest getCaseRequest)` Returns information about a specific case if it exists.
`GetCaseEventConfigurationResult`	`getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)` Returns the case event publishing configuration.
`GetDomainResult`	`getDomain(GetDomainRequest getDomainRequest)` Returns information about a specific domain if it exists.
`GetLayoutResult`	`getLayout(GetLayoutRequest getLayoutRequest)` Returns the details for the requested layout.
`GetTemplateResult`	`getTemplate(GetTemplateRequest getTemplateRequest)` Returns the details for the requested template.
`ListCasesForContactResult`	`listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)` Lists cases for a given contact.
`ListDomainsResult`	`listDomains(ListDomainsRequest listDomainsRequest)` Lists all cases domains in the Amazon Web Services account.
`ListFieldOptionsResult`	`listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)` Lists all of the field options for a field identifier in the domain.
`ListFieldsResult`	`listFields(ListFieldsRequest listFieldsRequest)` Lists all fields in a Cases domain.
`ListLayoutsResult`	`listLayouts(ListLayoutsRequest listLayoutsRequest)` Lists all layouts in the given cases domain.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists tags for a resource.
`ListTemplatesResult`	`listTemplates(ListTemplatesRequest listTemplatesRequest)` Lists all of the templates in a Cases domain.
`PutCaseEventConfigurationResult`	`putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)` API for adding case event publishing configuration
`SearchCasesResult`	`searchCases(SearchCasesRequest searchCasesRequest)` Searches for cases within their associated Cases domain.
`SearchRelatedItemsResult`	`searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest)` Searches for related items that are associated with a case.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Untags a resource.
`UpdateCaseResult`	`updateCase(UpdateCaseRequest updateCaseRequest)` Updates the values of fields on a case.
`UpdateFieldResult`	`updateField(UpdateFieldRequest updateFieldRequest)` Updates the properties of an existing field.
`UpdateLayoutResult`	`updateLayout(UpdateLayoutRequest updateLayoutRequest)` Updates the attributes of an existing layout.
`UpdateTemplateResult`	`updateTemplate(UpdateTemplateRequest updateTemplateRequest)` Updates the attributes of an existing template.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchGetField
```
BatchGetFieldResult batchGetField(BatchGetFieldRequest batchGetFieldRequest)
```
    Returns the description for the list of fields in the request parameters.
    
    Parameters:
    
    batchGetFieldRequest -
    
    Returns:
    
    Result of the BatchGetField 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
  - batchPutFieldOptions
```
BatchPutFieldOptionsResult batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)
```
    Creates and updates a set of field options for a single select field in a Cases domain.
    
    Parameters:
    
    batchPutFieldOptionsRequest -
    
    Returns:
    
    Result of the BatchPutFieldOptions 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
  - createCase
```
CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
```
    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.
    The following fields are required when creating a case:
    
    <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/profiles domain name/profiles/profile ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </note>
    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
```
CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
```
    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.
    
    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
```
CreateFieldResult createField(CreateFieldRequest createFieldRequest)
```
    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.
    
    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
```
CreateLayoutResult createLayout(CreateLayoutRequest createLayoutRequest)
```
    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.
    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
```
CreateRelatedItemResult createRelatedItem(CreateRelatedItemRequest createRelatedItemRequest)
```
    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.
    
    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
```
CreateTemplateResult createTemplate(CreateTemplateRequest createTemplateRequest)
```
    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.
    
    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
```
DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
```
    Deletes a domain.
    
    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
  - getCase
```
GetCaseResult getCase(GetCaseRequest getCaseRequest)
```
    Returns information about a specific case if it exists.
    
    Parameters:
    
    getCaseRequest -
    
    Returns:
    
    Result of the GetCase 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
  - getCaseEventConfiguration
```
GetCaseEventConfigurationResult getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)
```
    Returns the case event publishing configuration.
    
    Parameters:
    
    getCaseEventConfigurationRequest -
    
    Returns:
    
    Result of the GetCaseEventConfiguration 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
  - getDomain
```
GetDomainResult getDomain(GetDomainRequest getDomainRequest)
```
    Returns information about a specific domain if it exists.
    
    Parameters:
    
    getDomainRequest -
    
    Returns:
    
    Result of the GetDomain 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
  - getLayout
```
GetLayoutResult getLayout(GetLayoutRequest getLayoutRequest)
```
    Returns the details for the requested layout.
    
    Parameters:
    
    getLayoutRequest -
    
    Returns:
    
    Result of the GetLayout 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
  - getTemplate
```
GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
```
    Returns the details for the requested template.
    
    Parameters:
    
    getTemplateRequest -
    
    Returns:
    
    Result of the GetTemplate 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
  - listCasesForContact
```
ListCasesForContactResult listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)
```
    Lists cases for a given contact.
    
    Parameters:
    
    listCasesForContactRequest -
    
    Returns:
    
    Result of the ListCasesForContact 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
  - listDomains
```
ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
```
    Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
    
    Parameters:
    
    listDomainsRequest -
    
    Returns:
    
    Result of the ListDomains 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.
    
    See Also:
    
    AWS API Documentation
  - listFieldOptions
```
ListFieldOptionsResult listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)
```
    Lists all of the field options for a field identifier in the domain.
    
    Parameters:
    
    listFieldOptionsRequest -
    
    Returns:
    
    Result of the ListFieldOptions 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
  - listFields
```
ListFieldsResult listFields(ListFieldsRequest listFieldsRequest)
```
    Lists all fields in a Cases domain.
    
    Parameters:
    
    listFieldsRequest -
    
    Returns:
    
    Result of the ListFields 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
  - listLayouts
```
ListLayoutsResult listLayouts(ListLayoutsRequest listLayoutsRequest)
```
    Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
    
    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
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists tags for a resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource 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
  - listTemplates
```
ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
```
    Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
    
    Parameters:
    
    listTemplatesRequest -
    
    Returns:
    
    Result of the ListTemplates 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
  - putCaseEventConfiguration
```
PutCaseEventConfigurationResult putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)
```
    API for adding case event publishing configuration
    
    Parameters:
    
    putCaseEventConfigurationRequest -
    
    Returns:
    
    Result of the PutCaseEventConfiguration 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
```
SearchCasesResult searchCases(SearchCasesRequest searchCasesRequest)
```
    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 .
    
    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
  - searchRelatedItems
```
SearchRelatedItemsResult searchRelatedItems(SearchRelatedItemsRequest searchRelatedItemsRequest)
```
    Searches for related items that are associated with a case.
    
    If no filters are provided, this returns all related items associated with a case.
    
    Parameters:
    
    searchRelatedItemsRequest -
    
    Returns:
    
    Result of the SearchRelatedItems 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
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds tags to a resource.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource 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
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Untags a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource 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
```
UpdateCaseResult updateCase(UpdateCaseRequest updateCaseRequest)
```
    Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the CreateCase input .
    
    If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
    
    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
```
UpdateFieldResult updateField(UpdateFieldRequest updateFieldRequest)
```
    Updates the properties of an existing field.
    
    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
```
UpdateLayoutResult updateLayout(UpdateLayoutRequest updateLayoutRequest)
```
    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.
    
    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
```
UpdateTemplateResult updateTemplate(UpdateTemplateRequest updateTemplateRequest)
```
    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.
    
    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
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonConnectCases

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchGetField

batchPutFieldOptions

createCase

createDomain

createField

createLayout

createRelatedItem

createTemplate

deleteDomain

getCase

getCaseEventConfiguration

getDomain

getLayout

getTemplate

listCasesForContact

listDomains

listFieldOptions

listFields

listLayouts

listTagsForResource

listTemplates

putCaseEventConfiguration

searchCases

searchRelatedItems

tagResource

untagResource

updateCase

updateField

updateLayout

updateTemplate

shutdown

getCachedResponseMetadata