Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Returns the description for the list of fields in the request parameters.

Link copied to clipboard

Creates and updates a set of field options for a single select field in a Cases domain.

Link copied to clipboard
inline suspend fun ConnectCasesClient.createCase(crossinline block: CreateCaseRequest.Builder.() -> Unit): CreateCaseResponse

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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:

Link copied to clipboard

Creates a related item (comments, tasks, and contacts) and associates it with a case.

Link copied to clipboard

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.

Link copied to clipboard

Deletes a Cases domain.

Link copied to clipboard
inline suspend fun ConnectCasesClient.getCase(crossinline block: GetCaseRequest.Builder.() -> Unit): GetCaseResponse

Returns information about a specific case if it exists.

Link copied to clipboard

Returns the audit history about a specific case if it exists.

Link copied to clipboard

Returns the case event publishing configuration.

Link copied to clipboard
inline suspend fun ConnectCasesClient.getDomain(crossinline block: GetDomainRequest.Builder.() -> Unit): GetDomainResponse

Returns information about a specific domain if it exists.

Link copied to clipboard
inline suspend fun ConnectCasesClient.getLayout(crossinline block: GetLayoutRequest.Builder.() -> Unit): GetLayoutResponse

Returns the details for the requested layout.

Link copied to clipboard

Returns the details for the requested template.

Link copied to clipboard

Lists cases for a given contact.

Link copied to clipboard

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

Link copied to clipboard

Lists all of the field options for a field identifier in the domain.

Link copied to clipboard
inline suspend fun ConnectCasesClient.listFields(crossinline block: ListFieldsRequest.Builder.() -> Unit): ListFieldsResponse

Lists all fields in a Cases domain.

Link copied to clipboard

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

Link copied to clipboard

Lists tags for a resource.

Link copied to clipboard

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template.

Link copied to clipboard

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

Link copied to clipboard

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

Link copied to clipboard

Searches for related items that are associated with a case.

Link copied to clipboard

Adds tags to a resource.

Link copied to clipboard

Untags a resource.

Link copied to clipboard
inline suspend fun ConnectCasesClient.updateCase(crossinline block: UpdateCaseRequest.Builder.() -> Unit): UpdateCaseResponse

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide

Link copied to clipboard

Updates the properties of an existing field.

Link copied to clipboard

Updates the attributes of an existing layout.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.