Values (u.bd1fbe2ccff02fd1cddfdcb5f1e38e71.awso.0.9.1.doc.awso.connectcases.Awso

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

Source

val structure_to_value_aux : 
  ('a * 'b option) list ->
  f:(('a * 'b) list -> 'c) ->
  [> `Structure of 'c ]

Source

val structure_to_value : 
  ('a * 'b option) list ->
  [> `Structure of ('a * 'b) list ]

Source

val structure_to_wrapped_value : 
  wrapper:'a ->
  response:'a ->
  ('b * 'c option) list ->
  [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Sourcemodule String_ : sig ... end

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action.

Sourcemodule Arn : sig ... end

Sourcemodule AssociationTime : sig ... end

Sourcemodule RelatedItemType : sig ... end

Sourcemodule AuditEventType : sig ... end

Sourcemodule UserArn : sig ... end

Sourcemodule CustomEntity : sig ... end

Sourcemodule UserUnion : sig ... end

Represents the entity that performed the action.

Sourcemodule IamPrincipalArn : sig ... end

Sourcemodule AuditEventPerformedBy : sig ... end

Information of the user which performed the audit.

Sourcemodule AuditEventId : sig ... end

Sourcemodule EmptyFieldValue : sig ... end

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 Double : sig ... end

Sourcemodule Boolean : sig ... end

Sourcemodule AuditEventFieldValueUnionStringValueString : sig ... end

Sourcemodule AuditEventFieldValueUnion : sig ... end

Object to store union of Field values.

Sourcemodule AuditEventFieldId : sig ... end

Sourcemodule AuditEventField : sig ... end

Fields for audit event.

Sourcemodule AuditEventFieldList : sig ... end

Sourcemodule AuditEventDateTime : sig ... end

Sourcemodule AuditEvent : sig ... end

Represents the content of a particular audit event.

Sourcemodule FieldGroupNameString : sig ... end

Sourcemodule FieldId : sig ... end

Sourcemodule FieldItem : sig ... end

Object for field related information.

Sourcemodule FieldGroupFieldsList : sig ... end

Sourcemodule FieldGroup : sig ... end

Object for a group of fields and associated properties.

Sourcemodule Section : sig ... end

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

Sourcemodule SectionsList : sig ... end

Sourcemodule LayoutSections : sig ... end

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

Sourcemodule BasicLayout : sig ... end

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

Sourcemodule DomainId : sig ... end

Sourcemodule CaseRuleId : sig ... end

Sourcemodule CaseRuleIdentifier : sig ... end

Object containing case rule identifier information.

Sourcemodule CaseRuleIdentifierList : sig ... end

Sourcemodule BatchGetCaseRuleRequest : sig ... end

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.

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ThrottlingException : sig ... end

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

Sourcemodule ResourceNotFoundException : sig ... end

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.

Sourcemodule Integer : sig ... end

Sourcemodule InternalServerException : sig ... end

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

Sourcemodule BatchGetCaseRuleResponseUnprocessedCaseRulesList : sig ... end

Sourcemodule CaseRuleError : sig ... end

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 : sig ... end

Sourcemodule Tags : sig ... end

Sourcemodule LastModifiedTime : sig ... end

Sourcemodule Deleted : sig ... end

Sourcemodule CreatedTime : sig ... end

Sourcemodule CaseRuleName : sig ... end

Sourcemodule OperandTwoStringValueString : sig ... end

Sourcemodule EmptyOperandValue : sig ... end

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.

Sourcemodule OperandTwo : sig ... end

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.

Sourcemodule OperandOne : sig ... end

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.

Sourcemodule BooleanOperands : sig ... end

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.

module BooleanCondition : sig ... end

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 : sig ... end

module CompoundCondition : sig ... end

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.

Sourcemodule RequiredCaseRule : sig ... end

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.

Sourcemodule HiddenCaseRule : sig ... end

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

Sourcemodule ParentChildFieldOptionValue : sig ... end

Sourcemodule ParentChildFieldOptionsMappingChildFieldOptionValuesList : sig ... end

Sourcemodule ParentChildFieldOptionsMapping : sig ... end

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

Sourcemodule ParentChildFieldOptionsMappingList : sig ... end

Sourcemodule FieldOptionsCaseRule : sig ... end

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

Sourcemodule CaseRuleDetails : sig ... end

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.

Sourcemodule CaseRuleDescription : sig ... end

Sourcemodule CaseRuleArn : sig ... end

Sourcemodule GetCaseRuleResponse : sig ... end

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 : sig ... end

Sourcemodule BatchGetCaseRuleResponse : sig ... end

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.

Sourcemodule FieldIdentifier : sig ... end

Object for unique identifier of a field.

Sourcemodule BatchGetFieldIdentifierList : sig ... end

Sourcemodule BatchGetFieldRequest : sig ... end

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

Sourcemodule FieldType : sig ... end

Sourcemodule FieldNamespace : sig ... end

Sourcemodule FieldName : sig ... end

Sourcemodule FieldDescription : sig ... end

Sourcemodule TextAttributes : sig ... end

Field attributes for Text field type.

Sourcemodule FieldAttributes : sig ... end

Union of field attributes.

Sourcemodule FieldArn : sig ... end

Sourcemodule GetFieldResponse : sig ... end

Object to store detailed field information.

Sourcemodule BatchGetFieldResponseFieldsList : sig ... end

Sourcemodule FieldError : sig ... end

Object for errors on fields.

Sourcemodule BatchGetFieldResponseErrorsList : sig ... end

Sourcemodule BatchGetFieldResponse : sig ... end

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

Sourcemodule FieldOptionValue : sig ... end

Sourcemodule FieldOptionName : sig ... end

Sourcemodule FieldOption : sig ... end

Object for field Options information.

Sourcemodule BatchPutFieldOptionsRequestOptionsList : sig ... end

Sourcemodule BatchPutFieldOptionsRequest : sig ... end

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

Sourcemodule ServiceQuotaExceededException : sig ... end

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

Sourcemodule FieldOptionError : sig ... end

Object for field Options errors.

Sourcemodule BatchPutFieldOptionsResponseErrorsList : sig ... end

Sourcemodule BatchPutFieldOptionsResponse : sig ... end

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

Sourcemodule CaseArn : sig ... end

Sourcemodule CaseEventIncludedDataFieldsList : sig ... end

Sourcemodule CaseEventIncludedData : sig ... end

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

Sourcemodule TagValueString : sig ... end

Sourcemodule SearchTagKey : sig ... end

Sourcemodule TagValue : sig ... end

Object for case tag filter values.

Sourcemodule TagFilter : sig ... end

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

Sourcemodule FieldValueUnionStringValueString : sig ... end

Sourcemodule FieldValueUnion : sig ... end

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.

Sourcemodule FieldValue : sig ... end

Object for case field values.

Sourcemodule FieldFilter : sig ... end

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

module CaseFilter : sig ... end

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

module CaseFilterAndAllList : sig ... end

module CaseFilterOrAllList : sig ... end

Sourcemodule CaseId : sig ... end

Sourcemodule RuleType : sig ... end

Sourcemodule CaseRuleSummary : sig ... end

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.

Sourcemodule TemplateId : sig ... end

Sourcemodule CaseSummary : sig ... end

Case summary information.

Sourcemodule Channel : sig ... end

Sourcemodule CommentBody : sig ... end

Sourcemodule CommentBodyTextType : sig ... end

Sourcemodule CommentContent : sig ... end

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

Sourcemodule CommentFilter : sig ... end

A filter for related items of type Comment.

Sourcemodule CommentUpdateContent : sig ... end

Represents the updated content of a Comment related item.

Sourcemodule ConflictException : sig ... end

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.

Sourcemodule ConnectCaseContent : sig ... end

Represents the content of a ConnectCase type related item.

Sourcemodule ConnectCaseFilter : sig ... end

A filter for related items of type ConnectCase.

Sourcemodule ConnectCaseInputContent : sig ... end

Represents the content of a ConnectCase related item.

Sourcemodule ConnectedToSystemTime : sig ... end

Sourcemodule ContactArn : sig ... end

Sourcemodule Contact : sig ... end

An object that represents an Amazon Connect contact object.

Sourcemodule ContactContent : sig ... end

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

Sourcemodule ContactFilterChannelList : sig ... end

Sourcemodule ContactFilter : sig ... end

A filter for related items of type Contact.

Sourcemodule MutableTagKey : sig ... end

Sourcemodule MutableTags : sig ... end

Sourcemodule CreateCaseRequestFieldsList : sig ... end

Sourcemodule CreateCaseRequestClientTokenString : sig ... end

Sourcemodule CreateCaseRequest : sig ... end

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

Sourcemodule CreateCaseResponse : sig ... end

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

Sourcemodule CreateCaseRuleRequest : sig ... end

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.

Sourcemodule CreateCaseRuleResponse : sig ... end

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.

Sourcemodule DomainName : sig ... end

Sourcemodule CreateDomainRequest : sig ... end

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.

Sourcemodule DomainStatus : sig ... end

Sourcemodule DomainArn : sig ... end

Sourcemodule CreateDomainResponse : sig ... end

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.

Sourcemodule CreateFieldRequest : sig ... end

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.

Sourcemodule CreateFieldResponse : sig ... end

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.

Sourcemodule LayoutName : sig ... end

Sourcemodule LayoutContent : sig ... end

Object to store union of different versions of layout content.

Sourcemodule CreateLayoutRequest : sig ... end

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.

Sourcemodule LayoutId : sig ... end

Sourcemodule LayoutArn : sig ... end

Sourcemodule CreateLayoutResponse : sig ... end

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.

Sourcemodule TargetSlaMinutes : sig ... end

Sourcemodule SlaType : sig ... end

Sourcemodule SlaName : sig ... end

Sourcemodule SlaFieldValueUnionList : sig ... end

Sourcemodule SlaInputConfiguration : sig ... end

Represents the input configuration of an SLA being created.

Sourcemodule SlaInputContent : sig ... end

Represents the content of an SLA.

Sourcemodule FileArn : sig ... end

Sourcemodule FileContent : sig ... end

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

Sourcemodule CustomInputContentFieldsList : sig ... end

Sourcemodule CustomInputContent : sig ... end

Represents the content of a Custom related item.

Sourcemodule RelatedItemInputContent : sig ... end

Represents the content of a related item to be created.

Sourcemodule CreateRelatedItemRequest : sig ... end

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.

Sourcemodule RelatedItemId : sig ... end

Sourcemodule RelatedItemArn : sig ... end

Sourcemodule CreateRelatedItemResponse : sig ... end

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.

Sourcemodule TemplateStatus : sig ... end

Sourcemodule TemplateName : sig ... end

Sourcemodule TemplateDescription : sig ... end

Sourcemodule TemplateRule : sig ... end

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 TemplateCaseRuleList : sig ... end

Sourcemodule TagPropagationResourceType : sig ... end

Sourcemodule TagPropagationConfigurationTagMapMap : sig ... end

Sourcemodule TagPropagationConfiguration : sig ... end

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.

Sourcemodule TagPropagationConfigurationList : sig ... end

Sourcemodule RequiredField : sig ... end

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

Sourcemodule RequiredFieldList : sig ... end

Sourcemodule LayoutConfiguration : sig ... end

Object to store configuration of layouts associated to the template.

Sourcemodule CreateTemplateRequest : sig ... end

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

Sourcemodule TemplateArn : sig ... end

Sourcemodule CreateTemplateResponse : sig ... end

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

Sourcemodule FieldValueList : sig ... end

Sourcemodule CustomContent : sig ... end

Represents the content of a Custom type related item.

module CustomFieldsFilter : sig ... end

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

module CustomFieldsFilterAndAllList : sig ... end

module CustomFieldsFilterOrAllList : sig ... end

Sourcemodule CustomFilter : sig ... end

A filter for related items of type Custom.

Sourcemodule CustomUpdateContentFieldsList : sig ... end

Sourcemodule CustomUpdateContent : sig ... end

Represents the updated content of a Custom related item.

Sourcemodule DeleteCaseRequest : sig ... end

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.

Sourcemodule DeleteCaseResponse : sig ... end

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.

Sourcemodule DeleteCaseRuleRequest : sig ... end

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.

Sourcemodule DeleteCaseRuleResponse : sig ... end

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.

Sourcemodule DeleteDomainRequest : sig ... end

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.

Sourcemodule DeleteDomainResponse : sig ... end

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.

Sourcemodule DeleteFieldRequest : sig ... end

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.

Sourcemodule DeleteFieldResponse : sig ... end

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.

Sourcemodule DeleteLayoutRequest : sig ... end

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.

Sourcemodule DeleteLayoutResponse : sig ... end

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.

Sourcemodule DeleteRelatedItemRequest : sig ... end

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

Sourcemodule DeleteRelatedItemResponse : sig ... end

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

Sourcemodule DeleteTemplateRequest : sig ... end

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.

Sourcemodule DeleteTemplateResponse : sig ... end

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.

Sourcemodule DomainSummary : sig ... end

Object for the summarized details of the domain.

Sourcemodule DomainSummaryList : sig ... end

Sourcemodule RelatedItemEventIncludedData : sig ... end

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

Sourcemodule EventIncludedData : sig ... end

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

Sourcemodule EventBridgeConfiguration : sig ... end

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

Sourcemodule FieldOptionsList : sig ... end

Sourcemodule FieldSummary : sig ... end

Object for the summarized details of the field.

Sourcemodule FileFilter : sig ... end

A filter for related items of type File.

Sourcemodule NextToken : sig ... end

Sourcemodule GetCaseAuditEventsRequestMaxResultsInteger : sig ... end

Sourcemodule GetCaseAuditEventsRequest : sig ... end

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

Sourcemodule GetCaseAuditEventsResponseAuditEventsList : sig ... end

Sourcemodule GetCaseAuditEventsResponse : sig ... end

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

Sourcemodule GetCaseEventConfigurationRequest : sig ... end

Returns the case event publishing configuration.

Sourcemodule GetCaseEventConfigurationResponse : sig ... end

Returns the case event publishing configuration.

Sourcemodule GetCaseRequestFieldsList : sig ... end

Sourcemodule GetCaseRequest : sig ... end

Returns information about a specific case if it exists.

Sourcemodule GetCaseResponseFieldsList : sig ... end

Sourcemodule GetCaseResponse : sig ... end

Returns information about a specific case if it exists.

Sourcemodule GetDomainRequest : sig ... end

Returns information about a specific domain if it exists.

Sourcemodule GetDomainResponse : sig ... end

Returns information about a specific domain if it exists.

Sourcemodule GetLayoutRequest : sig ... end

Returns the details for the requested layout.

Sourcemodule GetLayoutResponse : sig ... end

Returns the details for the requested layout.

Sourcemodule GetTemplateRequest : sig ... end

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

Sourcemodule GetTemplateResponse : sig ... end

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

Sourcemodule LayoutSummary : sig ... end

Object for the summarized details of the layout.

Sourcemodule LayoutSummaryList : sig ... end

Sourcemodule MaxResults : sig ... end

Sourcemodule ListCaseRulesRequest : sig ... end

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 : sig ... end

Sourcemodule ListCaseRulesResponse : sig ... end

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 : sig ... end

Sourcemodule ListCasesForContactRequest : sig ... end

Lists cases for a given contact.

Sourcemodule ListCasesForContactResponseCasesList : sig ... end

Sourcemodule ListCasesForContactResponse : sig ... end

Lists cases for a given contact.

Sourcemodule ListDomainsRequestMaxResultsInteger : sig ... end

Sourcemodule ListDomainsRequest : sig ... end

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

Sourcemodule ListDomainsResponse : sig ... end

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

Sourcemodule Value : sig ... end

Sourcemodule ValuesList : sig ... end

Sourcemodule ListFieldOptionsRequest : sig ... end

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

Sourcemodule ListFieldOptionsResponse : sig ... end

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

Sourcemodule ListFieldsRequest : sig ... end

Lists all fields in a Cases domain.

Sourcemodule ListFieldsResponseFieldsList : sig ... end

Sourcemodule ListFieldsResponse : sig ... end

Lists all fields in a Cases domain.

Sourcemodule ListLayoutsRequest : sig ... end

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

Sourcemodule ListLayoutsResponse : sig ... end

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

Sourcemodule ListTagsForResourceRequest : sig ... end

Lists tags for a resource.

Sourcemodule ListTagsForResourceResponse : sig ... end

Lists tags for a resource.

Sourcemodule TemplateStatusFilters : sig ... end

Sourcemodule ListTemplatesRequest : sig ... end

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 TemplateSummary : sig ... end

Template summary information.

Sourcemodule ListTemplatesResponseTemplatesList : sig ... end

Sourcemodule ListTemplatesResponse : sig ... end

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 Order : sig ... end

Sourcemodule PutCaseEventConfigurationRequest : sig ... end

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 : sig ... end

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 SlaTargetTime : sig ... end

Sourcemodule SlaStatus : sig ... end

Sourcemodule SlaCompletionTime : sig ... end

Sourcemodule SlaConfiguration : sig ... end

Represents an SLA configuration.

Sourcemodule SlaContent : sig ... end

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

Sourcemodule RelatedItemContent : sig ... end

Represents the content of a particular type of related item.

Sourcemodule SlaFilter : sig ... end

A filter for related items of type SLA.

Sourcemodule RelatedItemTypeFilter : sig ... end

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

Sourcemodule RelatedItemUpdateContent : sig ... end

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 : sig ... end

Sourcemodule SearchAllRelatedItemsSort : sig ... end

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

Sourcemodule SearchAllRelatedItemsRequestSortsList : sig ... end

Sourcemodule SearchAllRelatedItemsRequestMaxResultsInteger : sig ... end

Sourcemodule SearchAllRelatedItemsRequestFiltersList : sig ... end

Sourcemodule SearchAllRelatedItemsRequest : sig ... end

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 : sig ... end

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

Sourcemodule SearchAllRelatedItemsResponseRelatedItemsList : sig ... end

Sourcemodule SearchAllRelatedItemsResponse : sig ... end

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 Sort : sig ... end

A structured set of sort terms.

Sourcemodule SearchCasesRequestSortsList : sig ... end

Sourcemodule SearchCasesRequestSearchTermString : sig ... end

Sourcemodule SearchCasesRequestMaxResultsInteger : sig ... end

Sourcemodule SearchCasesRequestFieldsList : sig ... end

Sourcemodule SearchCasesRequest : sig ... end

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 TotalCount : sig ... end

Sourcemodule SearchCasesResponseItemFieldsList : sig ... end

Sourcemodule SearchCasesResponseItem : sig ... end

A list of items that represent cases.

Sourcemodule SearchCasesResponseCasesList : sig ... end

Sourcemodule SearchCasesResponse : sig ... end

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 : sig ... end

Sourcemodule SearchRelatedItemsRequestFiltersList : sig ... end

Sourcemodule SearchRelatedItemsRequest : sig ... end

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

Sourcemodule SearchRelatedItemsResponseItem : sig ... end

A list of items that represent RelatedItems.

Sourcemodule SearchRelatedItemsResponseRelatedItemsList : sig ... end

Sourcemodule SearchRelatedItemsResponse : sig ... end

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

Sourcemodule TagKey : sig ... end

Sourcemodule TagKeyList : sig ... end

Sourcemodule TagResourceRequest : sig ... end

Adds tags to a resource.

Sourcemodule UntagResourceRequest : sig ... end

Untags a resource.

Sourcemodule UpdateCaseRequestFieldsList : sig ... end

Sourcemodule UpdateCaseRequest : sig ... end

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.

Sourcemodule UpdateCaseResponse : sig ... end

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.

Sourcemodule UpdateCaseRuleRequest : sig ... end

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.

Sourcemodule UpdateCaseRuleResponse : sig ... end

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.

Sourcemodule UpdateFieldRequest : sig ... end

Updates the properties of an existing field.

Sourcemodule UpdateFieldResponse : sig ... end

Updates the properties of an existing field.

Sourcemodule UpdateLayoutRequest : sig ... end

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.

Sourcemodule UpdateLayoutResponse : sig ... end

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.

Sourcemodule UpdateRelatedItemRequest : sig ... end

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.

Sourcemodule UpdateRelatedItemResponse : sig ... end

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.

Sourcemodule UpdateTemplateRequest : sig ... end

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

Sourcemodule UpdateTemplateResponse : sig ... end

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