View Source aws_connectcases (aws v1.0.4)
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: https://docs.aws.amazon.com/connect/latest/adminguide/cases.html in the Amazon Connect Administrator Guide.Summary
Functions
If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html permission on the User ARN resource that you provide
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.
Creates a field in the Cases domain.
Creates a layout in the Cases domain.
Creates a related item (comments, tasks, and contacts) and associates it with a case.
Creates a template in the Cases domain.
Deletes a Cases domain.
Lists all cases domains in the Amazon Web Services account.
Lists all layouts in the given cases domain.
Lists all of the templates in a Cases domain.
Adds case event publishing configuration.
Searches for cases within their associated Cases domain.
Searches for related items that are associated with a case.
If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html permission on the User ARN resource that you provide
Updates the attributes of an existing layout.
Updates the attributes of an existing template.
Functions
batch_put_field_options(Client, DomainId, FieldId, Input0, Options0)
View SourceIf you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html 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>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: https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases: https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam.
</important>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.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
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.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>Lists all cases domains in the Amazon Web Services account.
Each list item is a condensed summary object of the domain.Lists all layouts in the given cases domain.
Each list item is a condensed summary object of the layout.list_tags_for_resource(Client, Arn, QueryMap, HeadersMap, Options0)
View SourceLists all of the templates in a Cases domain.
Each list item is a condensed summary object of the template.Adds case event publishing configuration.
For a complete list of fields you can add to the event message, see Create case fields: https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html in the Amazon Connect Administrator GuideSearches for cases within their associated Cases domain.
Search results are returned as a paginated list of abridged case documents.
Forcustomer_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.
If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html 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>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.
Updates the attributes of an existing template.
The template attributes that can be modified includename, 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.