@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectCases
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| 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)
|
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 Cases domain.
|
DeleteFieldResult |
deleteField(DeleteFieldRequest deleteFieldRequest)
Deletes a field from a cases template.
|
DeleteLayoutResult |
deleteLayout(DeleteLayoutRequest deleteLayoutRequest)
Deletes a layout from a cases template.
|
DeleteTemplateResult |
deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
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 getCaseRequest)
Returns information about a specific case if it exists.
|
GetCaseAuditEventsResult |
getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest)
Returns the audit history 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)
Adds 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)
|
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.
|
static final String ENDPOINT_PREFIX
BatchGetFieldResult batchGetField(BatchGetFieldRequest batchGetFieldRequest)
Returns the description for the list of fields in the request parameters.
batchGetFieldRequest - 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.BatchPutFieldOptionsResult batchPutFieldOptions(BatchPutFieldOptionsRequest batchPutFieldOptionsRequest)
Creates and updates a set of field options for a single select field in a Cases domain.
batchPutFieldOptionsRequest - 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.CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
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>
createCaseRequest - 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.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.
</important>
createDomainRequest - 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.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.
createFieldRequest - 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.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.
createLayoutRequest - 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.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.
If you provide a value for performedBy.userArn you must also have DescribeUser permission
on the ARN of the user that you provide.
</note>
createRelatedItemRequest - 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.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.
createTemplateRequest - 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.DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
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>
deleteDomainRequest - 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.DeleteFieldResult deleteField(DeleteFieldRequest deleteFieldRequest)
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.
deleteFieldRequest - 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.DeleteLayoutResult deleteLayout(DeleteLayoutRequest deleteLayoutRequest)
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>
deleteLayoutRequest - 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.DeleteTemplateResult deleteTemplate(DeleteTemplateRequest deleteTemplateRequest)
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>
deleteTemplateRequest - 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.GetCaseResult getCase(GetCaseRequest getCaseRequest)
Returns information about a specific case if it exists.
getCaseRequest - 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.GetCaseAuditEventsResult getCaseAuditEvents(GetCaseAuditEventsRequest getCaseAuditEventsRequest)
Returns the audit history about a specific case if it exists.
getCaseAuditEventsRequest - 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.GetCaseEventConfigurationResult getCaseEventConfiguration(GetCaseEventConfigurationRequest getCaseEventConfigurationRequest)
Returns the case event publishing configuration.
getCaseEventConfigurationRequest - 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.GetDomainResult getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain if it exists.
getDomainRequest - 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.GetLayoutResult getLayout(GetLayoutRequest getLayoutRequest)
Returns the details for the requested layout.
getLayoutRequest - 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.GetTemplateResult getTemplate(GetTemplateRequest getTemplateRequest)
Returns the details for the requested template.
getTemplateRequest - 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.ListCasesForContactResult listCasesForContact(ListCasesForContactRequest listCasesForContactRequest)
Lists cases for a given contact.
listCasesForContactRequest - 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.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.
listDomainsRequest - 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.ListFieldOptionsResult listFieldOptions(ListFieldOptionsRequest listFieldOptionsRequest)
Lists all of the field options for a field identifier in the domain.
listFieldOptionsRequest - 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.ListFieldsResult listFields(ListFieldsRequest listFieldsRequest)
Lists all fields in a Cases domain.
listFieldsRequest - 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.ListLayoutsResult listLayouts(ListLayoutsRequest listLayoutsRequest)
Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.
listLayoutsRequest - 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists tags for a resource.
listTagsForResourceRequest - 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.ListTemplatesResult listTemplates(ListTemplatesRequest listTemplatesRequest)
Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.
listTemplatesRequest - 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.PutCaseEventConfigurationResult putCaseEventConfiguration(PutCaseEventConfigurationRequest putCaseEventConfigurationRequest)
Adds 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
putCaseEventConfigurationRequest - 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.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
.
searchCasesRequest - 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.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.
searchRelatedItemsRequest - 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds tags to a resource.
tagResourceRequest - 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Untags a resource.
untagResourceRequest - 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.UpdateCaseResult updateCase(UpdateCaseRequest updateCaseRequest)
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>
updateCaseRequest - 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.UpdateFieldResult updateField(UpdateFieldRequest updateFieldRequest)
Updates the properties of an existing field.
updateFieldRequest - 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.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.
updateLayoutRequest - 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.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.
updateTemplateRequest - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.