Module Awso_connectcases_lwtSource

Sourceval tag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_connectcases.Values.TagResourceRequest.t -> (unit, unit) Result.t Lwt.t
Sourceval untag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_connectcases.Values.UntagResourceRequest.t -> (unit, unit) Result.t Lwt.t
include module type of struct include Awso_connectcases.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule String_ = Awso_connectcases.Values.String_

You do not have sufficient access to perform this action.

Represents the entity that performed the action.

Information of the user which performed the audit.

An empty value. You cannot set EmptyFieldValue on a field that is required on a case template. This structure will never have any data members. It signifies an empty value on a case field.

Sourcemodule AuditEventFieldValueUnionStringValueString = Awso_connectcases.Values.AuditEventFieldValueUnionStringValueString

Object to store union of Field values.

Fields for audit event.

Represents the content of a particular audit event.

Object for field related information.

Object for a group of fields and associated properties.

This represents a sections within a panel or tab of the page layout.

Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.

Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of agent application.

Object containing case rule identifier information.

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

The request isn't valid. Check the syntax and try again.

The rate has been exceeded for this API. Please try again after a few minutes.

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.

We couldn't process your request because of an issue with the server. Try again later.

Sourcemodule BatchGetCaseRuleResponseUnprocessedCaseRulesList = Awso_connectcases.Values.BatchGetCaseRuleResponseUnprocessedCaseRulesList

Error for batch describe case rules API failure. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Sourcemodule BatchGetCaseRuleResponseErrorsList = Awso_connectcases.Values.BatchGetCaseRuleResponseErrorsList

Represents an empty operand value. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Represents the right hand operand in the condition. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Represents the left hand operand in the condition. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Boolean operands for a condition. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Boolean condition for a rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

module BooleanConditionList = Awso_connectcases.Values.BooleanConditionList

A compound condition that combines multiple boolean conditions using logical operators. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Required rule type, used to indicate whether a field is required. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

A rule that controls field visibility based on conditions. Fields can be shown or hidden dynamically based on values in other fields.

Sourcemodule ParentChildFieldOptionsMappingChildFieldOptionValuesList = Awso_connectcases.Values.ParentChildFieldOptionsMappingChildFieldOptionValuesList

A mapping between a parent field option value and child field option values.

Sourcemodule ParentChildFieldOptionsMappingList = Awso_connectcases.Values.ParentChildFieldOptionsMappingList

Rules that control which options are available in a child field based on the selected value in a parent field.

Represents what rule type should take place, under what conditions. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Detailed case rule information. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Sourcemodule BatchGetCaseRuleResponseCaseRulesList = Awso_connectcases.Values.BatchGetCaseRuleResponseCaseRulesList

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Object for unique identifier of a field.

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

Field attributes for Text field type.

Union of field attributes.

Object to store detailed field information.

Object for errors on fields.

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

Object for field Options information.

Sourcemodule BatchPutFieldOptionsRequestOptionsList = Awso_connectcases.Values.BatchPutFieldOptionsRequestOptionsList

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

The service quota has been exceeded. For a list of service quotas, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Object for field Options errors.

Sourcemodule BatchPutFieldOptionsResponseErrorsList = Awso_connectcases.Values.BatchPutFieldOptionsResponseErrorsList

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

Details of what case data is published through the case event stream.

Object for case tag filter values.

A filter for tags. Only one value can be provided.

Sourcemodule FieldValueUnionStringValueString = Awso_connectcases.Values.FieldValueUnionStringValueString

Object to store union of Field values. The Summary system field accepts up to 3000 characters, while all other fields accept up to 4100 characters. If you use multi-byte characters, the effective character limit may be lower.

Object for case field values.

A filter for fields. Only one value can be provided.

A filter for cases. Only one value can be provided.

module CaseFilterAndAllList = Awso_connectcases.Values.CaseFilterAndAllList

Summary information of this case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Case summary information.

Represents the content of a Comment to be returned to agents.

A filter for related items of type Comment.

Represents the updated content of a Comment related item.

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.

Represents the content of a ConnectCase type related item.

A filter for related items of type ConnectCase.

Represents the content of a ConnectCase related item.

An object that represents an Amazon Connect contact object.

An object that represents a content of an Amazon Connect contact object.

A filter for related items of type Contact.

Sourcemodule CreateCaseRequestClientTokenString = Awso_connectcases.Values.CreateCaseRequestClientTokenString

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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. When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case. The following fields are required when creating a case: customer_id - You must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID title

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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. When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case. The following fields are required when creating a case: customer_id - You must provide the full customer profile ARN in this format: arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID title

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Creates a new case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

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.

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.

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 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.

Object to store union of different versions of layout content.

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.

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.

Represents the input configuration of an SLA being created.

Represents the content of an SLA.

An object that represents a content of an Amazon Connect file object.

Represents the content of a Custom related item.

Represents the content of a related item to be created.

Creates a related item (comments, tasks, and contacts) and associates it with a case. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Use cases Following are examples of related items that you may want to associate with a case: Related contacts, such as calls, chats, emails tasks Comments, for agent notes SLAs, to capture target resolution goals Cases, to capture related Amazon Connect Cases Files, such as policy documentation or customer-provided attachments Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more Important things to know If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn. 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. The type field is reserved for internal use only. Endpoints: See Amazon Connect endpoints and quotas.

Creates a related item (comments, tasks, and contacts) and associates it with a case. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Use cases Following are examples of related items that you may want to associate with a case: Related contacts, such as calls, chats, emails tasks Comments, for agent notes SLAs, to capture target resolution goals Cases, to capture related Amazon Connect Cases Files, such as policy documentation or customer-provided attachments Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more Important things to know If you are associating a contact to a case by passing in Contact for a type, you must have DescribeContact permission on the ARN of the contact that you provide in content.contact.contactArn. 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. The type field is reserved for internal use only. Endpoints: See Amazon Connect endpoints and quotas.

An association representing a case rule acting upon a field. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Sourcemodule TagPropagationConfigurationTagMapMap = Awso_connectcases.Values.TagPropagationConfigurationTagMapMap

Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.

List of fields that must have a value provided to create a case.

Object to store configuration of layouts associated to the template.

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. Other template APIs are: DeleteTemplate GetTemplate ListTemplates UpdateTemplate

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. Other template APIs are: DeleteTemplate GetTemplate ListTemplates UpdateTemplate

Represents the content of a Custom type related item.

A filter for fields in Custom type related items. Only one value can be provided.

module CustomFieldsFilterAndAllList = Awso_connectcases.Values.CustomFieldsFilterAndAllList
module CustomFieldsFilterOrAllList = Awso_connectcases.Values.CustomFieldsFilterOrAllList

A filter for related items of type Custom.

Represents the updated content of a Custom related item.

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot: Retrieve related items Access audit history Perform any operations that require the CaseID This action is irreversible. After you delete a case, you cannot recover its data.

The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot: Retrieve related items Access audit history Perform any operations that require the CaseID This action is irreversible. After you delete a case, you cannot recover its data.

Deletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Deletes a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Deletes a Cases domain. 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 DeleteIntegrationAssociation.

Deletes a Cases domain. 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 DeleteIntegrationAssociation.

Deletes a field from a cases template. 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 identifiers in the request have been deleted. Calling GetCase with a deleted field identifier 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.

Deletes a field from a cases template. 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 identifiers in the request have been deleted. Calling GetCase with a deleted field identifier 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.

Deletes a layout from a cases template. You can delete up to 100 layouts per domain. After a layout is deleted: You can still retrieve the layout by calling GetLayout. You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException. Deleted layouts are not included in the ListLayouts response.

Deletes a layout from a cases template. You can delete up to 100 layouts per domain. After a layout is deleted: You can still retrieve the layout by calling GetLayout. You cannot update a deleted layout by calling UpdateLayout; it throws a ValidationException. Deleted layouts are not included in the ListLayouts response.

Deletes the related item resource under a case. This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API

Deletes the related item resource under a case. This API cannot be used on a FILE type related attachment. To delete this type of file, use the DeleteAttachedFile API

Deletes a cases template. You can delete up to 100 templates per domain. After a cases template is deleted: You can still retrieve the template by calling GetTemplate. You cannot update the template. You cannot create a case by using the deleted template. Deleted templates are not included in the ListTemplates response.

Deletes a cases template. You can delete up to 100 templates per domain. After a cases template is deleted: You can still retrieve the template by calling GetTemplate. You cannot update the template. You cannot create a case by using the deleted template. Deleted templates are not included in the ListTemplates response.

Object for the summarized details of the domain.

Details of what related item data is published through the case event stream.

Details of what case and related item data is published through the case event stream.

Configuration to enable EventBridge case event delivery and determine what data is delivered.

Object for the summarized details of the field.

A filter for related items of type File.

Sourcemodule GetCaseAuditEventsRequestMaxResultsInteger = Awso_connectcases.Values.GetCaseAuditEventsRequestMaxResultsInteger

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

Sourcemodule GetCaseAuditEventsResponseAuditEventsList = Awso_connectcases.Values.GetCaseAuditEventsResponseAuditEventsList

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

Sourcemodule GetCaseEventConfigurationRequest = Awso_connectcases.Values.GetCaseEventConfigurationRequest

Returns the case event publishing configuration.

Sourcemodule GetCaseEventConfigurationResponse = Awso_connectcases.Values.GetCaseEventConfigurationResponse

Returns the case event publishing configuration.

Returns information about a specific case if it exists.

Returns information about a specific case if it exists.

Returns information about a specific domain if it exists.

Returns information about a specific domain if it exists.

Returns the details for the requested layout.

Returns the details for the requested layout.

Returns the details for the requested template. Other template APIs are: CreateTemplate DeleteTemplate ListTemplates UpdateTemplate

Returns the details for the requested template. Other template APIs are: CreateTemplate DeleteTemplate ListTemplates UpdateTemplate

Object for the summarized details of the layout.

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Sourcemodule ListCaseRulesResponseCaseRulesList = Awso_connectcases.Values.ListCaseRulesResponseCaseRulesList

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Sourcemodule ListCasesForContactRequestMaxResultsInteger = Awso_connectcases.Values.ListCasesForContactRequestMaxResultsInteger

Lists cases for a given contact.

Sourcemodule ListCasesForContactResponseCasesList = Awso_connectcases.Values.ListCasesForContactResponseCasesList

Lists cases for a given contact.

Sourcemodule ListDomainsRequestMaxResultsInteger = Awso_connectcases.Values.ListDomainsRequestMaxResultsInteger

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

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

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

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

Lists all fields in a Cases domain.

Lists all fields in a Cases domain.

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

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

Lists tags for a resource.

Lists tags for a resource.

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate UpdateTemplate

Template summary information.

Sourcemodule ListTemplatesResponseTemplatesList = Awso_connectcases.Values.ListTemplatesResponseTemplatesList

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate UpdateTemplate

Sourcemodule PutCaseEventConfigurationRequest = Awso_connectcases.Values.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

Sourcemodule PutCaseEventConfigurationResponse = Awso_connectcases.Values.PutCaseEventConfigurationResponse

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

Represents an SLA configuration.

Represents the content of an SLA to be returned to agents.

Represents the content of a particular type of related item.

A filter for related items of type SLA.

The list of types of related items and their parameters to use for filtering.

Represents the content of a related item to be updated. This is a union type that can contain either comment content or custom content.

Sourcemodule SearchAllRelatedItemsSortProperty = Awso_connectcases.Values.SearchAllRelatedItemsSortProperty

The order in which all returned related items should be sorted.

Sourcemodule SearchAllRelatedItemsRequestSortsList = Awso_connectcases.Values.SearchAllRelatedItemsRequestSortsList
Sourcemodule SearchAllRelatedItemsRequestMaxResultsInteger = Awso_connectcases.Values.SearchAllRelatedItemsRequestMaxResultsInteger
Sourcemodule SearchAllRelatedItemsRequestFiltersList = Awso_connectcases.Values.SearchAllRelatedItemsRequestFiltersList

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API. Use cases Following are common uses cases for this API: Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions. Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts. Important things to know This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID. This API searches across related items content, not case fields. Use the SearchCases API to search within case field values. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule SearchAllRelatedItemsResponseItem = Awso_connectcases.Values.SearchAllRelatedItemsResponseItem

A list of items that represent RelatedItems. This data type is similar to SearchRelatedItemsResponseItem except SearchAllRelatedItemsResponseItem has a caseId field.

Sourcemodule SearchAllRelatedItemsResponseRelatedItemsList = Awso_connectcases.Values.SearchAllRelatedItemsResponseRelatedItemsList

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific SearchRelatedItems API. Use cases Following are common uses cases for this API: Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions. Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts. Important things to know This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the GetCase API for each returned case ID. This API searches across related items content, not case fields. Use the SearchCases API to search within case field values. Endpoints: See Amazon Connect endpoints and quotas.

A structured set of sort terms.

Sourcemodule SearchCasesRequestSearchTermString = Awso_connectcases.Values.SearchCasesRequestSearchTermString
Sourcemodule SearchCasesRequestMaxResultsInteger = Awso_connectcases.Values.SearchCasesRequestMaxResultsInteger

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.

Sourcemodule SearchCasesResponseItemFieldsList = Awso_connectcases.Values.SearchCasesResponseItemFieldsList

A list of items that represent cases.

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.

Sourcemodule SearchRelatedItemsRequestMaxResultsInteger = Awso_connectcases.Values.SearchRelatedItemsRequestMaxResultsInteger
Sourcemodule SearchRelatedItemsRequestFiltersList = Awso_connectcases.Values.SearchRelatedItemsRequestFiltersList

Searches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.

A list of items that represent RelatedItems.

Sourcemodule SearchRelatedItemsResponseRelatedItemsList = Awso_connectcases.Values.SearchRelatedItemsResponseRelatedItemsList

Searches for related items that are associated with a case. If no filters are provided, this returns all related items associated with a case.

Adds tags to a resource.

Untags a resource.

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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.

If you provide a value for PerformedBy.UserArn you must also have connect:DescribeUser permission on the User ARN resource that you provide 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.

Updates a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Updates a case rule. In the Amazon Connect admin website, case rules are known as case field conditions. For more information about case field conditions, see Add case field conditions to a case template.

Updates the properties of an existing field.

Updates the properties of an existing field.

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.

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.

Updates the content of a related item associated with a case. The following related item types are supported: Comment - Update the text content of an existing comment Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Important things to know When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed. If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide. System case fields cannot be used in a custom related item. Endpoints: See Amazon Connect endpoints and quotas.

Updates the content of a related item associated with a case. The following related item types are supported: Comment - Update the text content of an existing comment Custom - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See Amazon Connect Cases quotas. Important things to know When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed. If you provide a value for performedBy.userArn you must also have DescribeUser permission on the ARN of the user that you provide. System case fields cannot be used in a custom related item. Endpoints: See Amazon Connect endpoints and quotas.

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. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate ListTemplates

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. Other template APIs are: CreateTemplate DeleteTemplate GetTemplate ListTemplates