@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConnectCases extends Object implements AmazonConnectCases
AmazonConnectCases. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| 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)
|
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 Cases domain.
|
DeleteFieldResult |
deleteField(DeleteFieldRequest request)
Deletes a field from a cases template.
|
DeleteLayoutResult |
deleteLayout(DeleteLayoutRequest request)
Deletes a layout from a cases template.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest request)
Deletes a cases template.
|
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.
|
GetCaseAuditEventsResult |
getCaseAuditEvents(GetCaseAuditEventsRequest request)
Returns the audit history 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)
Adds 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)
|
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.
|
public BatchGetFieldResult batchGetField(BatchGetFieldRequest request)
AmazonConnectCasesReturns the description for the list of fields in the request parameters.
batchGetField in interface AmazonConnectCasespublic BatchPutFieldOptionsResult batchPutFieldOptions(BatchPutFieldOptionsRequest request)
AmazonConnectCasesCreates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptions in interface AmazonConnectCasespublic CreateCaseResult createCase(CreateCaseRequest request)
AmazonConnectCases
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>
createCase in interface AmazonConnectCasespublic CreateDomainResult createDomain(CreateDomainRequest request)
AmazonConnectCasesCreates 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>
createDomain in interface AmazonConnectCasespublic CreateFieldResult createField(CreateFieldRequest request)
AmazonConnectCasesCreates 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.
createField in interface AmazonConnectCasespublic CreateLayoutResult createLayout(CreateLayoutRequest request)
AmazonConnectCasesCreates 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.
createLayout in interface AmazonConnectCasespublic CreateRelatedItemResult createRelatedItem(CreateRelatedItemRequest request)
AmazonConnectCasesCreates 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>
createRelatedItem in interface AmazonConnectCasespublic CreateTemplateResult createTemplate(CreateTemplateRequest request)
AmazonConnectCasesCreates 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.
createTemplate in interface AmazonConnectCasespublic DeleteDomainResult deleteDomain(DeleteDomainRequest request)
AmazonConnectCasesDeletes 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>
deleteDomain in interface AmazonConnectCasespublic DeleteFieldResult deleteField(DeleteFieldRequest request)
AmazonConnectCasesDeletes 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.
deleteField in interface AmazonConnectCasespublic DeleteLayoutResult deleteLayout(DeleteLayoutRequest request)
AmazonConnectCasesDeletes 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>
deleteLayout in interface AmazonConnectCasespublic DeleteTemplateResult deleteTemplate(DeleteTemplateRequest request)
AmazonConnectCasesDeletes 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>
deleteTemplate in interface AmazonConnectCasespublic GetCaseResult getCase(GetCaseRequest request)
AmazonConnectCasesReturns information about a specific case if it exists.
getCase in interface AmazonConnectCasespublic GetCaseAuditEventsResult getCaseAuditEvents(GetCaseAuditEventsRequest request)
AmazonConnectCasesReturns the audit history about a specific case if it exists.
getCaseAuditEvents in interface AmazonConnectCasespublic GetCaseEventConfigurationResult getCaseEventConfiguration(GetCaseEventConfigurationRequest request)
AmazonConnectCasesReturns the case event publishing configuration.
getCaseEventConfiguration in interface AmazonConnectCasespublic GetDomainResult getDomain(GetDomainRequest request)
AmazonConnectCasesReturns information about a specific domain if it exists.
getDomain in interface AmazonConnectCasespublic GetLayoutResult getLayout(GetLayoutRequest request)
AmazonConnectCasesReturns the details for the requested layout.
getLayout in interface AmazonConnectCasespublic GetTemplateResult getTemplate(GetTemplateRequest request)
AmazonConnectCasesReturns the details for the requested template.
getTemplate in interface AmazonConnectCasespublic ListCasesForContactResult listCasesForContact(ListCasesForContactRequest request)
AmazonConnectCasesLists cases for a given contact.
listCasesForContact in interface AmazonConnectCasespublic ListDomainsResult listDomains(ListDomainsRequest request)
AmazonConnectCasesLists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.
listDomains in interface AmazonConnectCasespublic ListFieldOptionsResult listFieldOptions(ListFieldOptionsRequest request)
AmazonConnectCasesLists all of the field options for a field identifier in the domain.
listFieldOptions in interface AmazonConnectCasespublic ListFieldsResult listFields(ListFieldsRequest request)
AmazonConnectCasesLists all fields in a Cases domain.
listFields in interface AmazonConnectCasespublic ListLayoutsResult listLayouts(ListLayoutsRequest request)
AmazonConnectCasesLists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayouts in interface AmazonConnectCasespublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonConnectCasesLists tags for a resource.
listTagsForResource in interface AmazonConnectCasespublic ListTemplatesResult listTemplates(ListTemplatesRequest request)
AmazonConnectCasesLists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplates in interface AmazonConnectCasespublic PutCaseEventConfigurationResult putCaseEventConfiguration(PutCaseEventConfigurationRequest request)
AmazonConnectCasesAdds case event publishing configuration. For a complete list of fields you can add to the event message, see Create case fields in the Amazon Connect Administrator Guide
putCaseEventConfiguration in interface AmazonConnectCasespublic SearchCasesResult searchCases(SearchCasesRequest request)
AmazonConnectCasesSearches 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
.
searchCases in interface AmazonConnectCasespublic SearchRelatedItemsResult searchRelatedItems(SearchRelatedItemsRequest request)
AmazonConnectCasesSearches for related items that are associated with a case.
If no filters are provided, this returns all related items associated with a case.
searchRelatedItems in interface AmazonConnectCasespublic TagResourceResult tagResource(TagResourceRequest request)
AmazonConnectCasesAdds tags to a resource.
tagResource in interface AmazonConnectCasespublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonConnectCasesUntags a resource.
untagResource in interface AmazonConnectCasespublic UpdateCaseResult updateCase(UpdateCaseRequest request)
AmazonConnectCases
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>
updateCase in interface AmazonConnectCasespublic UpdateFieldResult updateField(UpdateFieldRequest request)
AmazonConnectCasesUpdates the properties of an existing field.
updateField in interface AmazonConnectCasespublic UpdateLayoutResult updateLayout(UpdateLayoutRequest request)
AmazonConnectCasesUpdates 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.
updateLayout in interface AmazonConnectCasespublic UpdateTemplateResult updateTemplate(UpdateTemplateRequest request)
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.
updateTemplate in interface AmazonConnectCasespublic void shutdown()
AmazonConnectCasesshutdown in interface AmazonConnectCasespublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConnectCasesResponse 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.
getCachedResponseMetadata in interface AmazonConnectCasesrequest - The originally executed request.