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.

• CaseEventIncludedData

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

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

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

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

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

• Sort

  A structured set of sort terms.

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

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

• 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 1500 characters while all other fields accept 500 characters.

• LayoutContent

  Object to store union of different versions of layout content.

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

• Section

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

• 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 identity of the person who performed the action.