Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon Connect Cases can respond with.

Structs

AuditEvent

Represents the content of a particular audit event.

AuditEventField

Fields for audit event.

AuditEventPerformedBy

Information of the user which performed the audit.

BasicLayout

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

BooleanOperands

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.

CaseEventIncludedData

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

CaseRuleError

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.

CaseRuleIdentifier

Object containing case rule identifier information.

CaseRuleSummary

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.

CaseSummary

Case summary information.

CommentContent

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

CommentFilter

A filter for related items of type Comment.

Contact

An object that represents an Amazon Connect contact object.

ContactContent

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

ContactFilter

A filter for related items of type Contact.

DomainSummary

Object for the summarized details of the domain.

EmptyFieldValue

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.

EmptyOperandValue

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.

EventBridgeConfiguration

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

EventIncludedData

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

FieldError

Object for errors on fields.

FieldGroup

Object for a group of fields and associated properties.

FieldIdentifier

Object for unique identifier of a field.

FieldItem

Object for field related information.

FieldOption

Object for field Options information.

FieldOptionError

Object for field Options errors.

FieldSummary

Object for the summarized details of the field.

FieldValue

Object for case field values.

FileContent

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

FileFilter

A filter for related items of type File.

GetCaseRuleResponse

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.

GetFieldResponse

Object to store detailed field information.

LayoutConfiguration

Object to store configuration of layouts associated to the template.

LayoutSections

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

LayoutSummary

Object for the summarized details of the layout.

RelatedItemEventIncludedData

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

RequiredCaseRule

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.

RequiredField

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

SearchCasesResponseItem

A list of items that represent cases.

SearchRelatedItemsResponseItem

A list of items that represent RelatedItems.

SlaConfiguration

Represents an SLA configuration.

SlaContent

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

SlaFilter

A filter for related items of type SLA.

SlaInputConfiguration

Represents the input configuration of an SLA being created.

Sort

A structured set of sort terms.

TemplateRule

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.

TemplateSummary

Template summary information.

Enums

AuditEventFieldValueUnion

Object to store union of Field values.

AuditEventType

When writing a match expression against AuditEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

BooleanCondition

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.

CaseFilter

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

CaseRuleDetails

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.

CommentBodyTextType

When writing a match expression against CommentBodyTextType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DomainStatus

When writing a match expression against DomainStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FieldFilter

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

FieldNamespace

When writing a match expression against FieldNamespace, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FieldType

When writing a match expression against FieldType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FieldValueUnion

Object to store union of Field values.

The Summary system field accepts 3000 characters while all other fields accept 500 characters.

LayoutContent

Object to store union of different versions of layout content.

OperandOne

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.

OperandTwo

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.

Order

When writing a match expression against Order, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RelatedItemContent

Represents the content of a particular type of related item.

RelatedItemInputContent

Represents the content of a related item to be created.

RelatedItemType

When writing a match expression against RelatedItemType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RelatedItemTypeFilter

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

RuleType

When writing a match expression against RuleType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Section

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

SlaInputContent

Represents the content of an SLA.

SlaStatus

When writing a match expression against SlaStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SlaType

When writing a match expression against SlaType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TemplateStatus

When writing a match expression against TemplateStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UserUnion

Represents the entity that performed the action.