AbstractAmazonConnectCases (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connectcases.AbstractAmazonConnectCases

All Implemented Interfaces:

AmazonConnectCases

Direct Known Subclasses:

AbstractAmazonConnectCasesAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonConnectCases
extends Object
implements AmazonConnectCases
```
Abstract implementation of AmazonConnectCases. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.connectcases.AmazonConnectCases
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchGetFieldResult`	`batchGetField(BatchGetFieldRequest request)` Returns the description for the list of fields in the request parameters.
`BatchPutFieldOptionsResult`	`batchPutFieldOptions(BatchPutFieldOptionsRequest request)` Creates and updates a set of field options for a single select field in a Cases domain.
`CreateCaseResult`	`createCase(CreateCaseRequest request)` Creates a case in the specified Cases domain.
`CreateDomainResult`	`createDomain(CreateDomainRequest request)` Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
`CreateFieldResult`	`createField(CreateFieldRequest request)` Creates a field in the Cases domain.
`CreateLayoutResult`	`createLayout(CreateLayoutRequest request)` Creates a layout in the Cases domain.
`CreateRelatedItemResult`	`createRelatedItem(CreateRelatedItemRequest request)` Creates a related item (comments, tasks, and contacts) and associates it with a case.
`CreateTemplateResult`	`createTemplate(CreateTemplateRequest request)` Creates a template in the Cases domain.
`DeleteDomainResult`	`deleteDomain(DeleteDomainRequest request)` 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 request)` Returns information about a specific case if it exists.
`GetCaseEventConfigurationResult`	`getCaseEventConfiguration(GetCaseEventConfigurationRequest request)` Returns the case event publishing configuration.
`GetDomainResult`	`getDomain(GetDomainRequest request)` Returns information about a specific domain if it exists.
`GetLayoutResult`	`getLayout(GetLayoutRequest request)` Returns the details for the requested layout.
`GetTemplateResult`	`getTemplate(GetTemplateRequest request)` Returns the details for the requested template.
`ListCasesForContactResult`	`listCasesForContact(ListCasesForContactRequest request)` Lists cases for a given contact.
`ListDomainsResult`	`listDomains(ListDomainsRequest request)` Lists all cases domains in the Amazon Web Services account.
`ListFieldOptionsResult`	`listFieldOptions(ListFieldOptionsRequest request)` Lists all of the field options for a field identifier in the domain.
`ListFieldsResult`	`listFields(ListFieldsRequest request)` Lists all fields in a Cases domain.
`ListLayoutsResult`	`listLayouts(ListLayoutsRequest request)` Lists all layouts in the given cases domain.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists tags for a resource.
`ListTemplatesResult`	`listTemplates(ListTemplatesRequest request)` Lists all of the templates in a Cases domain.
`PutCaseEventConfigurationResult`	`putCaseEventConfiguration(PutCaseEventConfigurationRequest request)` API for adding case event publishing configuration
`SearchCasesResult`	`searchCases(SearchCasesRequest request)` Searches for cases within their associated Cases domain.
`SearchRelatedItemsResult`	`searchRelatedItems(SearchRelatedItemsRequest request)` 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 request)` Adds tags to a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Untags a resource.
`UpdateCaseResult`	`updateCase(UpdateCaseRequest request)` Updates the values of fields on a case.
`UpdateFieldResult`	`updateField(UpdateFieldRequest request)` Updates the properties of an existing field.
`UpdateLayoutResult`	`updateLayout(UpdateLayoutRequest request)` Updates the attributes of an existing layout.
`UpdateTemplateResult`	`updateTemplate(UpdateTemplateRequest request)` Updates the attributes of an existing template.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - batchGetField
```
public BatchGetFieldResult batchGetField(BatchGetFieldRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns the description for the list of fields in the request parameters.
    
    Specified by:
    
    batchGetField in interface AmazonConnectCases
    
    Returns:
    
    Result of the BatchGetField operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchPutFieldOptions
```
public BatchPutFieldOptionsResult batchPutFieldOptions(BatchPutFieldOptionsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Creates and updates a set of field options for a single select field in a Cases domain.
    
    Specified by:
    
    batchPutFieldOptions in interface AmazonConnectCases
    
    Returns:
    
    Result of the BatchPutFieldOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createCase
```
public CreateCaseResult createCase(CreateCaseRequest request)
```
    Description copied from interface: AmazonConnectCases
    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>
    Specified by:
    
    createCase in interface AmazonConnectCases
    
    Returns:
    
    Result of the CreateCase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDomain
```
public CreateDomainResult createDomain(CreateDomainRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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.
    
    Specified by:
    
    createDomain in interface AmazonConnectCases
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createField
```
public CreateFieldResult createField(CreateFieldRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the CreateField operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLayout
```
public CreateLayoutResult createLayout(CreateLayoutRequest request)
```
    Description copied from interface: AmazonConnectCases
    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
    
    Returns:
    
    Result of the CreateLayout operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRelatedItem
```
public CreateRelatedItemResult createRelatedItem(CreateRelatedItemRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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.
    
    Specified by:
    
    createRelatedItem in interface AmazonConnectCases
    
    Returns:
    
    Result of the CreateRelatedItem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTemplate
```
public CreateTemplateResult createTemplate(CreateTemplateRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the CreateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDomain
```
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Deletes a domain.
    
    Specified by:
    
    deleteDomain in interface AmazonConnectCases
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCase
```
public GetCaseResult getCase(GetCaseRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns information about a specific case if it exists.
    
    Specified by:
    
    getCase in interface AmazonConnectCases
    
    Returns:
    
    Result of the GetCase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getCaseEventConfiguration
```
public GetCaseEventConfigurationResult getCaseEventConfiguration(GetCaseEventConfigurationRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns the case event publishing configuration.
    
    Specified by:
    
    getCaseEventConfiguration in interface AmazonConnectCases
    
    Returns:
    
    Result of the GetCaseEventConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDomain
```
public GetDomainResult getDomain(GetDomainRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns information about a specific domain if it exists.
    
    Specified by:
    
    getDomain in interface AmazonConnectCases
    
    Returns:
    
    Result of the GetDomain operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLayout
```
public GetLayoutResult getLayout(GetLayoutRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns the details for the requested layout.
    
    Specified by:
    
    getLayout in interface AmazonConnectCases
    
    Returns:
    
    Result of the GetLayout operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTemplate
```
public GetTemplateResult getTemplate(GetTemplateRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Returns the details for the requested template.
    
    Specified by:
    
    getTemplate in interface AmazonConnectCases
    
    Returns:
    
    Result of the GetTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCasesForContact
```
public ListCasesForContactResult listCasesForContact(ListCasesForContactRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists cases for a given contact.
    
    Specified by:
    
    listCasesForContact in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListCasesForContact operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDomains
```
public ListDomainsResult listDomains(ListDomainsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
    
    Specified by:
    
    listDomains in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListDomains operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFieldOptions
```
public ListFieldOptionsResult listFieldOptions(ListFieldOptionsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists all of the field options for a field identifier in the domain.
    
    Specified by:
    
    listFieldOptions in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListFieldOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFields
```
public ListFieldsResult listFields(ListFieldsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists all fields in a Cases domain.
    
    Specified by:
    
    listFields in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListFields operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLayouts
```
public ListLayoutsResult listLayouts(ListLayoutsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the ListLayouts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists tags for a resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTemplates
```
public ListTemplatesResult listTemplates(ListTemplatesRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
    
    Specified by:
    
    listTemplates in interface AmazonConnectCases
    
    Returns:
    
    Result of the ListTemplates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putCaseEventConfiguration
```
public PutCaseEventConfigurationResult putCaseEventConfiguration(PutCaseEventConfigurationRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    API for adding case event publishing configuration
    
    Specified by:
    
    putCaseEventConfiguration in interface AmazonConnectCases
    
    Returns:
    
    Result of the PutCaseEventConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchCases
```
public SearchCasesResult searchCases(SearchCasesRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the SearchCases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - searchRelatedItems
```
public SearchRelatedItemsResult searchRelatedItems(SearchRelatedItemsRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Searches for related items that are associated with a case.
    
    If no filters are provided, this returns all related items associated with a case.
    
    Specified by:
    
    searchRelatedItems in interface AmazonConnectCases
    
    Returns:
    
    Result of the SearchRelatedItems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Adds tags to a resource.
    
    Specified by:
    
    tagResource in interface AmazonConnectCases
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Untags a resource.
    
    Specified by:
    
    untagResource in interface AmazonConnectCases
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateCase
```
public UpdateCaseResult updateCase(UpdateCaseRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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.
    
    Specified by:
    
    updateCase in interface AmazonConnectCases
    
    Returns:
    
    Result of the UpdateCase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateField
```
public UpdateFieldResult updateField(UpdateFieldRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    Updates the properties of an existing field.
    
    Specified by:
    
    updateField in interface AmazonConnectCases
    
    Returns:
    
    Result of the UpdateField operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLayout
```
public UpdateLayoutResult updateLayout(UpdateLayoutRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the UpdateLayout operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTemplate
```
public UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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
    
    Returns:
    
    Result of the UpdateTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonConnectCases
    
    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 AmazonConnectCases
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonConnectCases
    
    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 AmazonConnectCases
    
    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?

Class AbstractAmazonConnectCases

Field Summary

Fields inherited from interface com.amazonaws.services.connectcases.AmazonConnectCases

Method Summary

Methods inherited from class java.lang.Object

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