Module aws_sdk_connect::model

source ·
Expand description

Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.

Modules

Structs

Information about an action.

Information about the contact associated to the user.

Information about the agent who accepted the contact.

Contains information about an agent status.

Information about the agent's status.

Summary information for an agent status.

Configuration of the answering machine detection.

This action must be set if TriggerEventSource is one of the following values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable. Contact is categorized using the rule name.

Information about a reference when the referenceType is ATTACHMENT. Otherwise, null.

A toggle for an individual feature at the instance level.

Information about available phone numbers.

A chat message.

Configuration information for the chat participant role.

The streaming configuration, such as the Amazon SNS streaming endpoint.

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

Contains information about a contact.

Filters user data based on the contact information that is associated to the users. It contains a list of contact states.

Contains information about a flow.

Contains information about a flow module.

Contains summary information about a flow.

Contains summary information about a flow.

An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

Contains credentials to use for federation.

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Contains the data for a real-time metric.

Contains information about a set of real-time metrics.

The way to sort the resulting response based on metrics. By default resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the input metrics.

Information about a reference when the referenceType is DATE. Otherwise, null.

Contains information about a default vocabulary.

Contains information about the dimensions for a set of metrics.

Information about a traffic distribution.

Information about a reference when the referenceType is EMAIL. Otherwise, null.

The encryption configuration.

The EventBridge action definition.

Contains the filter to apply when retrieving metrics.

Contains information about a hierarchy group.

A leaf node condition which can be used to specify a hierarchy group condition.

Contains summary information about a hierarchy group.

Information about the hierarchy group.

Contains information about a hierarchy level.

Contains information about the hierarchy level to update.

Contains information about the levels of a hierarchy group.

Information about the levels in the hierarchy group.

Contains information about a hierarchy structure.

Contains information about the level hierarchy to update.

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Contains the data for a historical metric.

Contains information about the historical metrics retrieved.

Information about of the hours of operation.

Contains information about the hours of operation.

Contains summary information about hours of operation for a contact center.

The start time or end time for an hours of operation.

The Amazon Connect instance.

Relevant details why the instance was not successfully created.

The storage configuration for the instance.

Information about the instance.

Contains summary information about the associated AppIntegrations.

A field that is invisible to an agent.

Configuration information of a Kinesis Data Firehose delivery stream.

Configuration information of a Kinesis data stream.

Configuration information of a Kinesis video stream.

Configuration information of an Amazon Lex bot.

Configuration information of an Amazon Lex or Amazon Lex V2 bot.

Configuration information of an Amazon Lex V2 bot.

Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

The type of notification recipient.

Information about a reference when the referenceType is NUMBER. Otherwise, null.

The outbound caller ID name, number, and outbound whisper flow.

The customer's details.

Configuration information for the timer. After the timer configuration is set, it persists for the duration of the chat. It persists across new contacts in the chain, for example, transfer contacts.

Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.

Contains information about a phone number for a quick connect.

The status of the phone number.

Contains summary information about a phone number for a contact center.

Information about a problem detail.

Contains information about the prompt.

Contains information about why a property is not valid.

Contains information about a queue.

If this contact was queued, this contains information about the queue.

Contains information about a queue for a quick connect. The flow must be of type Transfer to Queue.

Contains information about a queue resource for which metrics are returned.

The search criteria to be used to return queues.

Filters to be applied to search results.

Contains summary information about a queue.

Contains information about a quick connect.

Contains configuration settings for a quick connect.

Contains summary information about a quick connect.

Indicates a field that is read-only to an agent.

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

Information about a required field.

Contains information about a routing profile.

Contains information about the queue and channel for which priority and delay can be set.

Contains summary information about a routing profile queue.

Contains the channel and queue identifier for a routing profile.

Information about the routing profile assigned to the user.

The search criteria to be used to return routing profiles.

Filters to be applied to search results.

Contains summary information about a routing profile.

Information about a rule.

Information about the action to be performed when a rule is triggered.

A list of ActionTypes associated with a rule.

The name of the event source. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Information about the Amazon Simple Storage Service (Amazon S3) storage type.

Configuration information of the security key.

Contains information about a security profile.

The search criteria to be used to return security profiles.

Information about the returned security profiles.

Contains information about a security profile.

Filters to be applied to search results.

Information about the send notification action.

A leaf node condition which can be used to specify a string condition.

Information about a reference when the referenceType is STRING. Otherwise, null.

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

Information about the task action.

Describes constraints that apply to the template fields.

Describes a default field and its corresponding value.

Describes default values for fields on a template.

Describes a single task template field.

The identifier of the task template field.

Contains summary information about the task template.

The distribution of traffic between the instance and its replicas.

Contains information about the threshold for service level metrics.

Information about a traffic distribution group.

Information about traffic distribution groups.

The URL reference.

Contains the use case.

Contains information about a user account for an Amazon Connect instance.

Data for a user.

A filter for the user data.

Contains information about the identity of a user.

The user's first name and last name.

Contains information about the phone configuration settings for a user.

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

Information about the user.

The search criteria to be used to return users.

Filters to be applied to search results.

Information about the returned users.

Contains summary information about a user.

Contains information about a custom vocabulary.

Contains summary information about the custom vocabulary.

Contains information about the recording configuration settings.

Enums

When writing a match expression against ActionType, 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.
When writing a match expression against AgentStatusState, 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.
When writing a match expression against AgentStatusType, 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.
When writing a match expression against Channel, 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.
When writing a match expression against Comparison, 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.
When writing a match expression against ContactFlowModuleState, 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.
When writing a match expression against ContactFlowModuleStatus, 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.
When writing a match expression against ContactFlowState, 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.
When writing a match expression against ContactFlowType, 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.
When writing a match expression against ContactInitiationMethod, 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.
When writing a match expression against ContactState, 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.
When writing a match expression against CurrentMetricName, 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.
When writing a match expression against DirectoryType, 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.
When writing a match expression against EncryptionType, 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.
When writing a match expression against EventSourceName, 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.
When writing a match expression against Grouping, 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.
When writing a match expression against HierarchyGroupMatchType, 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.
When writing a match expression against HistoricalMetricName, 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.
When writing a match expression against HoursOfOperationDays, 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.
When writing a match expression against InstanceAttributeType, 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.
When writing a match expression against InstanceStatus, 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.
When writing a match expression against InstanceStorageResourceType, 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.
When writing a match expression against IntegrationType, 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.
When writing a match expression against LexVersion, 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.
When writing a match expression against MonitorCapability, 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.
When writing a match expression against NotificationContentType, 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.
When writing a match expression against NotificationDeliveryType, 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.
When writing a match expression against ParticipantTimerAction, 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.
When writing a match expression against ParticipantTimerType, 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.

The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in minutes. Only one value can be set.

When writing a match expression against PhoneNumberCountryCode, 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.
When writing a match expression against PhoneNumberType, 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.
When writing a match expression against PhoneNumberWorkflowStatus, 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.
When writing a match expression against PhoneType, 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.
When writing a match expression against PropertyValidationExceptionReason, 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.
When writing a match expression against QueueStatus, 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.
When writing a match expression against QueueType, 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.
When writing a match expression against QuickConnectType, 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.
When writing a match expression against ReferenceStatus, 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.

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

When writing a match expression against ReferenceType, 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.
When writing a match expression against RehydrationType, 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.
When writing a match expression against ResourceType, 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.
When writing a match expression against RulePublishStatus, 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.
When writing a match expression against SearchableQueueType, 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.
When writing a match expression against SortOrder, 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.
When writing a match expression against SourceType, 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.
When writing a match expression against Statistic, 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.
When writing a match expression against StorageType, 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.
When writing a match expression against StringComparisonType, 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.
When writing a match expression against TaskTemplateFieldType, 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.
When writing a match expression against TaskTemplateStatus, 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.
When writing a match expression against TimerEligibleParticipantRoles, 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.
When writing a match expression against TrafficDistributionGroupStatus, 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.
When writing a match expression against TrafficType, 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.
When writing a match expression against Unit, 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.

Configuration information for the chat participant role.

When writing a match expression against UseCaseType, 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.
When writing a match expression against VocabularyLanguageCode, 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.
When writing a match expression against VocabularyState, 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.
When writing a match expression against VoiceRecordingTrack, 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.