Module Awso_connect.Values_1Source

Sourcemodule UserPhoneConfig : sig ... end

Contains information about the phone configuration settings for a user.

Sourcemodule Email : sig ... end
Sourcemodule UserIdentityInfo : sig ... end

Contains information about the identity of a user. For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory. The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

Sourcemodule SecurityProfileIds : sig ... end
Sourcemodule PhoneNumberConfig : sig ... end

Configuration settings for phone type and phone number.

Sourcemodule PhoneNumberConfigs : sig ... end

Configuration settings for persistent connection for a specific channel.

Sourcemodule Password : sig ... end
Sourcemodule DirectoryUserId : sig ... end
Sourcemodule CreateUserRequest : sig ... end

Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

Sourcemodule CreateUserResponse : sig ... end

Creates a user account for the specified Amazon Connect instance. Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Amazon Connect or SAML for identity management. Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically: PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration. For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.

Sourcemodule ViewsInstanceId : sig ... end
Sourcemodule ViewsClientToken : sig ... end
Sourcemodule ViewStatus : sig ... end
Sourcemodule ViewName : sig ... end
Sourcemodule ViewTemplate : sig ... end
Sourcemodule ViewAction : sig ... end
Sourcemodule ViewActions : sig ... end
Sourcemodule ViewInputContent : sig ... end

View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.

Sourcemodule ViewDescription : sig ... end
Sourcemodule CreateViewRequest : sig ... end

Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Sourcemodule ViewVersion : sig ... end
Sourcemodule ViewType : sig ... end
Sourcemodule ViewId : sig ... end
Sourcemodule ViewContentSha256 : sig ... end
Sourcemodule ViewInputSchema : sig ... end
Sourcemodule ViewContent : sig ... end

View content containing all content necessary to render a view except for runtime input data.

Sourcemodule View : sig ... end

A view resource object. Contains metadata and content necessary to render the view.

Sourcemodule TooManyRequestsException : sig ... end

Displayed when rate-related API limits are exceeded.

Sourcemodule ResourceType : sig ... end
Sourcemodule ResourceInUseException : sig ... end

That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.

Sourcemodule CreateViewResponse : sig ... end

Creates a new view with the possible status of SAVED or PUBLISHED. The views will have a unique name for each connect instance. It performs basic content validation if the status is SAVED or full content validation if the status is set to PUBLISHED. An error is returned if validation fails. It associates either the $SAVED qualifier or both of the $SAVED and $LATEST qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

Sourcemodule CreateViewVersionRequest : sig ... end

Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Sourcemodule CreateViewVersionResponse : sig ... end

Publishes a new version of the view identifier. Versions are immutable and monotonically increasing. It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the $LATEST alias.

Sourcemodule VocabularyName : sig ... end
Sourcemodule VocabularyContent : sig ... end
Sourcemodule CreateVocabularyRequest : sig ... end

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Sourcemodule VocabularyState : sig ... end
Sourcemodule CreateVocabularyResponse : sig ... end

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

Sourcemodule Slug : sig ... end
Sourcemodule Page : sig ... end
Sourcemodule InputData : sig ... end

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

Sourcemodule WorkspaceTitle : sig ... end
Sourcemodule WorkspaceFontFamily : sig ... end
Sourcemodule FontFamily : sig ... end

Contains font family configuration for workspace themes.

Sourcemodule WorkspaceThemeTypography : sig ... end

Contains typography configuration for a workspace theme.

Sourcemodule ThemeString : sig ... end
Sourcemodule PalettePrimary : sig ... end

Contains primary color configuration for a workspace theme.

Sourcemodule PaletteNavigation : sig ... end

Contains color configuration for navigation elements in a workspace theme.

Sourcemodule PaletteHeader : sig ... end

Contains color configuration for header elements in a workspace theme.

Sourcemodule PaletteCanvas : sig ... end

Contains color configuration for canvas elements in a workspace theme.

Sourcemodule WorkspaceThemePalette : sig ... end

Contains color palette configuration for different areas of a workspace.

Contains logo image configuration for workspace themes.

Sourcemodule WorkspaceThemeImages : sig ... end

Contains image configuration for a workspace theme.

Sourcemodule WorkspaceThemeConfig : sig ... end

Contains detailed theme configuration for a workspace, including colors, images, and typography.

Sourcemodule WorkspaceTheme : sig ... end

Contains theme configuration for a workspace, supporting both light and dark modes.

Sourcemodule WorkspaceName : sig ... end
Sourcemodule WorkspaceDescription : sig ... end
Sourcemodule CreateWorkspaceRequest : sig ... end

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Sourcemodule CreateWorkspaceResponse : sig ... end

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

Sourcemodule SecurityToken : sig ... end
Sourcemodule Credentials : sig ... end

Contains credentials to use for federation.

Sourcemodule Unit : sig ... end
Sourcemodule CurrentMetricName : sig ... end
Sourcemodule CurrentMetricId : sig ... end
Sourcemodule CurrentMetric : sig ... end

Contains information about a real-time metric. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. Only one of either the Name or MetricId is required.

Sourcemodule Value : sig ... end
Sourcemodule CurrentMetricData : sig ... end

Contains the data for a real-time metric.

Sourcemodule ValidationTestType : sig ... end
Sourcemodule Subtype : sig ... end
Sourcemodule RoutingProfileReference : sig ... end

Information about the routing profile assigned to the user.

Sourcemodule RoutingExpression : sig ... end
Sourcemodule Dimensions : sig ... end

Contains information about the dimensions for a set of metrics.

Sourcemodule CurrentMetricResult : sig ... end

Contains information about a set of real-time metrics.

Sourcemodule CurrentMetricResults : sig ... end
Sourcemodule SortOrder : sig ... end
Sourcemodule CurrentMetricSortCriteria : sig ... end

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.

Sourcemodule CurrentMetrics : sig ... end
Sourcemodule CustomerIdNonEmpty : sig ... end
Sourcemodule DataTable : sig ... end

Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and safe way.

Sourcemodule DataTableEvaluatedValue : sig ... end

A data table evaluated value.

Sourcemodule DataTableList : sig ... end
module DataTableSearchConditionList : sig ... end
module DataTableSearchCriteria : sig ... end

A data table search criteria.

Sourcemodule DataTableSearchFilter : sig ... end

A data table search filter.

Sourcemodule DataTableSummary : sig ... end

A data table summary.

Sourcemodule DataTableSummaryList : sig ... end

A data table value evaluation set.

Sourcemodule DataTableValueSummary : sig ... end

A data table value summary.

Sourcemodule DataTableValueSummaryList : sig ... end
Sourcemodule DateComparisonType : sig ... end
Sourcemodule DateYearMonthDayFormat : sig ... end
Sourcemodule DateCondition : sig ... end

An object to specify the hours of operation override date condition.

Sourcemodule DateReference : sig ... end

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

Sourcemodule DateTimeComparisonType : sig ... end
Sourcemodule DateTimeFormat : sig ... end
Sourcemodule DateTimeCondition : sig ... end

A datetime search condition for Search APIs.

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.

Sourcemodule DecimalComparisonType : sig ... end
Sourcemodule NullableDouble : sig ... end
Sourcemodule DecimalCondition : sig ... end

A decimal search condition for Search APIs.

Sourcemodule DefaultVocabulary : sig ... end

Contains information about a default vocabulary.

Sourcemodule DefaultVocabularyList : sig ... end
Sourcemodule DeleteAttachedFileRequest : sig ... end

Request to DeleteAttachedFile API

Response from DeleteAttachedFile API

Deletes a contact evaluation in the specified Amazon Connect instance.

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

Deletes the specified flow module.

Deletes the specified flow module.

Removes a specific version of a contact flow module.

Removes a specific version of a contact flow module.

Sourcemodule DeleteContactFlowRequest : sig ... end

Deletes a flow for the specified Amazon Connect instance.

Sourcemodule DeleteContactFlowResponse : sig ... end

Deletes a flow for the specified Amazon Connect instance.

Deletes the particular version specified in flow version identifier.

Deletes the particular version specified in flow version identifier.

Deletes an attribute and all its values from a data table.

Deletes an attribute and all its values from a data table.

Sourcemodule DeleteDataTableRequest : sig ... end

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

Sourcemodule DeleteDataTableResponse : sig ... end

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

Sourcemodule DeleteEmailAddressRequest : sig ... end

Deletes email address from the specified Amazon Connect instance.

Deletes email address from the specified Amazon Connect instance.

Deletes an evaluation form in the specified Amazon Connect instance. If the version property is provided, only the specified version of the evaluation form is deleted. If no version is provided, then the full form (all versions) is deleted.

Deletes an hours of operation override in an Amazon Connect hours of operation resource.

Deletes an hours of operation.

Sourcemodule DeleteInstanceRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Deletes the Amazon Connect instance. For more information, see Delete your Amazon Connect instance in the Amazon Connect Administrator Guide. Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.

Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

Sourcemodule DeleteNotificationRequest : sig ... end

Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

The response from deleting a notification.

Deletes a predefined attribute from the specified Amazon Connect instance.

Sourcemodule DeletePromptRequest : sig ... end

Deletes a prompt.

Deletes registration for a device token and a chat contact.

Deletes registration for a device token and a chat contact.

Sourcemodule DeleteQueueRequest : sig ... end

Deletes a queue.

Sourcemodule DeleteQuickConnectRequest : sig ... end

Deletes a quick connect. After calling DeleteUser, it's important to call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

Deletes a routing profile.

Sourcemodule DeleteRuleRequest : sig ... end

Deletes a rule for the specified Amazon Connect instance.

Deletes a security profile.

Sourcemodule DeleteTaskTemplateRequest : sig ... end

Deletes the task template.

Deletes the task template.

Sourcemodule DeleteTestCaseRequest : sig ... end

Deletes the test case that has already been created for the specified Amazon Connect instance.

Sourcemodule DeleteTestCaseResponse : sig ... end

Deletes the test case that has already been created for the specified Amazon Connect instance.

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. For more information about deleting traffic distribution groups, see Delete traffic distribution groups in the Amazon Connect Administrator Guide.

Sourcemodule DeleteUseCaseRequest : sig ... end

Deletes a use case from an integration association.

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Sourcemodule DeleteUserRequest : sig ... end

Deletes a user account from the specified Amazon Connect instance. For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide. After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you: Avoid dangling resources that impact your service quotas. Remove deleted users so they don't appear to agents as transfer options. Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

Sourcemodule DeleteViewRequest : sig ... end

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

Sourcemodule DeleteViewResponse : sig ... end

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

Sourcemodule DeleteViewVersionRequest : sig ... end

Deletes the particular version specified in ViewVersion identifier.

Sourcemodule DeleteViewVersionResponse : sig ... end

Deletes the particular version specified in ViewVersion identifier.

Sourcemodule DeleteVocabularyRequest : sig ... end

Deletes the vocabulary that has the given identifier.

Sourcemodule DeleteVocabularyResponse : sig ... end

Deletes the vocabulary that has the given identifier.

Sourcemodule MediaType : sig ... end

Deletes a media asset (such as a logo) from a workspace.

Deletes a media asset (such as a logo) from a workspace.

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

Sourcemodule DeleteWorkspaceRequest : sig ... end

Deletes a workspace and removes all associated view and resource assignments.

Sourcemodule DeleteWorkspaceResponse : sig ... end

Deletes a workspace and removes all associated view and resource assignments.

Describes an agent status.

Describes an agent status.

Describes the attached files configuration for the specified Amazon Connect instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.

Describes the attached files configuration for the specified Amazon Connect instance and attachment scope. If a custom configuration exists for the specified attachment scope, the custom configuration is returned. If no custom configuration exists, the default configuration values for that attachment scope are returned.

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Describes the target authentication profile.

Describes a contact evaluation in the specified Amazon Connect instance.

Sourcemodule EvaluationFormContent : sig ... end

Information about an evaluation form used in a contact evaluation.

Sourcemodule EvaluationType : sig ... end
Sourcemodule EvaluationStatus : sig ... end
Sourcemodule EvaluationScorePercentage : sig ... end
Sourcemodule EvaluationScore : sig ... end

Information about scores of a contact evaluation item (section or question).

Sourcemodule EvaluationScoresMap : sig ... end
Sourcemodule EvaluationNoteString : sig ... end
Sourcemodule EvaluationNote : sig ... end

Information about notes for a contact evaluation.

Sourcemodule EvaluationNotesMap : sig ... end

A comment provided when requesting an evaluation review.

Sourcemodule EvaluationReviewMetadata : sig ... end

Metadata information about an evaluation review.

Information about a contact participant in the evaluation.

Sourcemodule EvaluationAcknowledgement : sig ... end

Information about the evaluation acknowledgement.

Sourcemodule EvaluationMetadata : sig ... end

Metadata information about a contact evaluation.

Sourcemodule EvaluationTranscriptType : sig ... end

Details of the input data used for automated question processing.

The milliseconds offset for transcript reference in suggested answer.

Information about the point of interest in transcript provided to evaluation.

An analysis for a generative AI answer to the question.

The Contact Lens category used by evaluation automation.

Analysis details providing explanation for Contact Lens automation decision.

Detailed analysis results of the automated answer to the evaluation question.

Sourcemodule EvaluationAnswerData : sig ... end

Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.

Sourcemodule EvaluationSuggestedAnswer : sig ... end

The information about the suggested answer for the question.

Sourcemodule EvaluationAnswerOutput : sig ... end

Information about output answers for a contact evaluation.

Sourcemodule Evaluation : sig ... end

Information about a contact evaluation.

Describes a contact evaluation in the specified Amazon Connect instance.

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Describes the specified flow module. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published.

Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Describes the specified flow. You can also create and update flows using the Amazon Connect Flow language. Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. After a flow is published, $SAVED needs to be supplied to view saved content that has not been published. Use arn:aws:.../contact-flow/{id}:{version} to retrieve the content of a specific flow version. In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

Sourcemodule DescribeContactRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule DescribeContactResponse : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Describes the specified contact. Use cases Following are common uses cases for this API: Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions. Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup. Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream. Important things to know SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API. Endpoints: See Amazon Connect endpoints and quotas.

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Sourcemodule DescribeDataTableRequest : sig ... end

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Sourcemodule DescribeDataTableResponse : sig ... end

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Describe email address form the specified Amazon Connect instance.

Describe email address form the specified Amazon Connect instance.

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

Sourcemodule EvaluationForm : sig ... end

Information about the evaluation form.

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

Describes the hours of operation override.

Sourcemodule HoursOfOperationOverride : sig ... end

Information about the hours of operations override.

Describes the hours of operation override.

Describes the hours of operation.

Sourcemodule HoursOfOperation : sig ... end

Information about of the hours of operation.

Describes the hours of operation.

This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.

This API is in preview release for Amazon Connect and is subject to change. Describes the specified instance attribute.

Sourcemodule DescribeInstanceRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Sourcemodule ReplicationStatusReason : sig ... end
Sourcemodule InstanceReplicationStatus : sig ... end
Sourcemodule ReplicationStatusSummary : sig ... end

Status information about the replication process, where you use the ReplicateInstance API to create a replica of your Amazon Connect instance in another Amazon Web Services Region. For more information, see Set up Amazon Connect Global Resiliency in the Amazon Connect Administrator Guide.

Sourcemodule GlobalSignInEndpoint : sig ... end
Sourcemodule ReplicationConfiguration : sig ... end

Details about the status of the replication of a source Amazon Connect instance across Amazon Web Services Regions. Use these details to understand the general status of a given replication. For information about why a replication process may fail, see Why a ReplicateInstance call fails in the Create a replica of your existing Amazon Connect instance topic in the Amazon Connect Administrator Guide.

Sourcemodule Url : sig ... end
Sourcemodule InstanceStatusReason : sig ... end

Relevant details why the instance was not successfully created.

Sourcemodule InstanceStatus : sig ... end
Sourcemodule Instance : sig ... end

The Amazon Connect instance.

Sourcemodule DescribeInstanceResponse : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

This API is in preview release for Amazon Connect and is subject to change. Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

Sourcemodule NotificationPriority : sig ... end
Sourcemodule Notification : sig ... end

Contains information about a notification, including its content, priority, recipients, and metadata.

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException.

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a ResourceNotFoundException.

Describes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Amazon Connect quotas. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule IsReadOnly : sig ... end

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

Sourcemodule PredefinedAttribute : sig ... end

Information about a predefined attribute.

Describes a predefined attribute for the specified Amazon Connect instance. A predefined attribute is made up of a name and a value. You can use predefined attributes for: Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see Create predefined attributes for routing contacts to agents. Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see Use contact segment attributes. For the predefined attributes per instance quota, see Amazon Connect quotas. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule DescribePromptRequest : sig ... end

Describes the prompt.

Sourcemodule Prompt : sig ... end

Information about a prompt.

Sourcemodule DescribePromptResponse : sig ... end

Describes the prompt.

Sourcemodule DescribeQueueRequest : sig ... end

Describes the specified queue.

Sourcemodule QueueStatus : sig ... end
Sourcemodule Queue : sig ... end

Contains information about a queue.

Sourcemodule DescribeQueueResponse : sig ... end

Describes the specified queue.

Describes the quick connect.

Sourcemodule QuickConnect : sig ... end

Contains information about a quick connect.

Describes the quick connect.

Describes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.

Sourcemodule Long : sig ... end
Sourcemodule RoutingProfile : sig ... end

Contains information about a routing profile.

Describes the specified routing profile. DescribeRoutingProfile does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. SearchRoutingProfiles does include AssociatedQueueIds.

Sourcemodule DescribeRuleRequest : sig ... end

Describes a rule for the specified Amazon Connect instance.

Sourcemodule Rule : sig ... end

Information about a rule.

Sourcemodule DescribeRuleResponse : sig ... end

Describes a rule for the specified Amazon Connect instance.

Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Sourcemodule SecurityProfileName : sig ... end
Sourcemodule SecurityProfile : sig ... end

Contains information about a security profile.

Gets basic information about the security profile. For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.

Sourcemodule DescribeTestCaseRequest : sig ... end

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

Sourcemodule TestCaseSha256 : sig ... end
Sourcemodule TestCase : sig ... end

Contains information about a test case.

Sourcemodule DescribeTestCaseResponse : sig ... end

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

Gets details and status of a traffic distribution group.

Sourcemodule InstanceArn : sig ... end
Sourcemodule TrafficDistributionGroup : sig ... end

Information about a traffic distribution group.

Gets details and status of a traffic distribution group.

Describes the specified hierarchy group.

Sourcemodule HierarchyGroupSummary : sig ... end

Contains summary information about a hierarchy group.

Sourcemodule HierarchyPath : sig ... end

Contains information about the levels of a hierarchy group.

Sourcemodule HierarchyLevelId : sig ... end
Sourcemodule HierarchyGroup : sig ... end

Contains information about a hierarchy group.

Describes the specified hierarchy group.

Describes the hierarchy structure of the specified Amazon Connect instance.

Sourcemodule HierarchyLevelName : sig ... end
Sourcemodule HierarchyLevel : sig ... end

Contains information about a hierarchy level.

Sourcemodule HierarchyStructure : sig ... end

Contains information about a hierarchy structure.

Describes the hierarchy structure of the specified Amazon Connect instance.

Sourcemodule DescribeUserRequest : sig ... end

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Sourcemodule User : sig ... end

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

Sourcemodule DescribeUserResponse : sig ... end

Describes the specified user. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Sourcemodule DescribeViewRequest : sig ... end

Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Sourcemodule DescribeViewResponse : sig ... end

Retrieves the view for the specified Amazon Connect instance and view identifier. The view identifier can be supplied as a ViewId or ARN. $SAVED needs to be supplied if a view is unpublished. The view identifier can contain an optional qualifier, for example, <view-id>:$SAVED, which is either an actual version number or an Amazon Connect managed qualifier $SAVED | $LATEST. If it is not supplied, then $LATEST is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Sourcemodule DescribeVocabularyRequest : sig ... end

Describes the specified vocabulary.

Sourcemodule VocabularyFailureReason : sig ... end
Sourcemodule Vocabulary : sig ... end

Contains information about a custom vocabulary.

Describes the specified vocabulary.

Sourcemodule DescribeWorkspaceRequest : sig ... end

Retrieves details about a workspace, including its configuration and metadata.

Sourcemodule Visibility : sig ... end
Sourcemodule Workspace : sig ... end

Contains information about a workspace, which defines the user experience by mapping views to pages.

Sourcemodule DescribeWorkspaceResponse : sig ... end

Retrieves details about a workspace, including its configuration and metadata.

Sourcemodule DestinationId : sig ... end

Outbound calls to the destination number are not allowed.

Sourcemodule DimensionsV2Key : sig ... end
Sourcemodule DimensionsV2Value : sig ... end
Sourcemodule DimensionsV2Map : sig ... end

Removes the dataset ID associated with a given Amazon Connect instance.

This API is in preview release for Amazon Connect and is subject to change. Revokes access to integrated applications from Amazon Connect.

Sourcemodule DisassociateBotRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot.

Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Amazon Connect endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).

Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly. Use cases Following are common uses cases for this API: Department separation: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues. Email address retirement: Cleanly remove forwarding relationships before decommissioning old email addresses. Organizational restructuring: Reconfigure email routing when business processes change and aliases are no longer needed. Important things to know Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked. Emails sent to the former alias address are still delivered directly to that address if it exists. You do not need to delete the email addresses after disassociation. Both addresses remain active independently. After a successful disassociation, you can immediately create a new alias relationship with the same addresses. 200 status means alias was successfully disassociated. DisassociateEmailAddressAlias does not return the following information: Details in the response about the email that was disassociated. The response returns an empty body. The timestamp of when the disassociation occurred. Endpoints: See Amazon Connect endpoints and quotas. Related operations AssociateEmailAddressAlias: Associates an email address alias with an existing email address in an Amazon Connect instance. DescribeEmailAddress: View current alias configurations for an email address. SearchEmailAddresses: Find email addresses and their alias relationships across an instance. CreateEmailAddress: Create new email addresses that can participate in alias relationships. DeleteEmailAddress: Remove email addresses (automatically removes any alias relationships). UpdateEmailAddressMetadata: Modify email address properties (does not affect alias relationships).

Sourcemodule DisassociateFlowRequest : sig ... end

Disassociates a connect resource from a flow.

Sourcemodule DisassociateFlowResponse : sig ... end

Disassociates a connect resource from a flow.

Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide here for more information on inheriting overrides from parent hours of operation(s).

This API is in preview release for Amazon Connect and is subject to change. Removes the storage type configurations for the specified resource type and association ID.

This API is in preview release for Amazon Connect and is subject to change. Remove the Lambda function from the dropdown options available in the relevant flow blocks.

Sourcemodule DisassociateLexBotRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Removes the flow association from a phone number claimed to your Amazon Connect instance. If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Sourcemodule EmailAddressIdList : sig ... end

Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue. Important things to know Agents will no longer see these email addresses in their "From" address selection options for this queue. The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed. Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).

Disassociates a set of quick connects from a queue.

Disassociates a set of queues from a routing profile. Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.

This API is in preview release for Amazon Connect and is subject to change. Deletes the specified security key.

Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

Information about proficiency to be disassociated from the user.

Disassociates a set of proficiencies from a user.

Removes the association between a workspace and one or more users or routing profiles.

Removes the association between a workspace and one or more users or routing profiles.

Sourcemodule DisconnectOnCustomerExit : sig ... end
Sourcemodule DisconnectReasonCode : sig ... end
Sourcemodule DisconnectReason : sig ... end

Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide this field.

Sourcemodule DismissUserContactRequest : sig ... end

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.

Sourcemodule MetadataUrl : sig ... end
Sourcemodule DownloadUrlMetadata : sig ... end

Metadata used to download the attached file.

Sourcemodule OperationalHour : sig ... end

Information about the hours of operations with the effective override applied.

Sourcemodule OperationalHours : sig ... end

Information about the hours of operations with the effective override applied.

Sourcemodule OperationalStatus : sig ... end
Sourcemodule OverrideHour : sig ... end

Information about hours of operation override

Sourcemodule OverrideHours : sig ... end
Sourcemodule EffectiveOverrideHours : sig ... end

Information about the hours of operation overrides which contribute to effective hours of operations.

Sourcemodule EmailAddressInfo : sig ... end

Contains information about a source or destination email address.

Sourcemodule EmailAddressMetadata : sig ... end

Contains information about an email address for a contact center.

Sourcemodule EmailAddressList : sig ... end
Sourcemodule EmailAddressSummary : sig ... end

Summary information about an email address associated with a queue. Contains the essential details needed to identify and manage the email address routing configuration.

Sourcemodule EmailAddressMetadataList : sig ... end
Sourcemodule EmailAddressRecipientList : sig ... end
module EmailAddressSearchConditionList : sig ... end
module EmailAddressSearchCriteria : sig ... end

The search criteria to be used to return email addresses.

Sourcemodule EmailAddressSearchFilter : sig ... end

Filters to be applied to search results.

Sourcemodule PreSignedAttachmentUrl : sig ... end
Sourcemodule EmailAttachment : sig ... end

Information about the email attachment files.

Sourcemodule EmailAttachments : sig ... end
Sourcemodule EmailHeaderType : sig ... end
Sourcemodule EmailHeaderValue : sig ... end
Sourcemodule EmailHeaders : sig ... end
Sourcemodule EmailMessageContentType : sig ... end
Sourcemodule EmailMessageReference : sig ... end

Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.

Sourcemodule EmailReference : sig ... end

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

Sourcemodule EpochMilliseconds : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxResult100 : sig ... end

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: Amazon Web Services API Standards.

Summary information about an evaluation acknowledgement.

Sourcemodule EvaluationAnswerInput : sig ... end

Information about input answers for a contact evaluation.

Sourcemodule EvaluationAnswersInputMap : sig ... end
module EvaluationFormSearchCriteria : sig ... end

The search criteria to be used to return evaluation forms.

Filters to be applied to search results.

Information about the returned evaluation forms.

Sourcemodule EvaluationFormSummary : sig ... end

Summary information about an evaluation form.

Sourcemodule EvaluationFormSummaryList : sig ... end

Summary information about an evaluation form.

module EvaluationSearchConditionList : sig ... end
module EvaluationSearchCriteria : sig ... end

The search criteria to be used to return evaluations.

Sourcemodule EvaluationSearchFilter : sig ... end

Filters to be applied to search results.

Sourcemodule EvaluationSearchMetadata : sig ... end

Metadata information about an evaluation search.

Sourcemodule EvaluationSearchSummary : sig ... end

Summary of evaluation obtained from the search operation.

Sourcemodule EvaluationSummary : sig ... end

Summary information about a contact evaluation.

Sourcemodule EvaluationSummaryList : sig ... end
Sourcemodule EvaluatorUserUnion : sig ... end

Represents the entity that performed the action on the evaluation.

Sourcemodule TestCaseResourceId : sig ... end
Sourcemodule ExecutionRecordString : sig ... end
Sourcemodule ExecutionRecordStatus : sig ... end
Sourcemodule ExecutionRecord : sig ... end

Contains information about a test case execution record.

Sourcemodule ExecutionRecordList : sig ... end
Sourcemodule ResourceArnOrId : sig ... end
Sourcemodule FilterValueList : sig ... end
Sourcemodule FilterV2StringCondition : sig ... end

System defined filtering condition. For example, the NOT_EXISTS StringCondition returns documents where the field specified by FilterKey does not exist in the document. When the NOT_EXISTS StringCondition is added to a FilterV2 object, FilterValues must be null or empty.

Sourcemodule FilterV2 : sig ... end

Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.

Sourcemodule ValidationTestTypes : sig ... end
Sourcemodule Subtypes : sig ... end
Sourcemodule RoutingProfiles : sig ... end
Sourcemodule RoutingExpressions : sig ... end
Sourcemodule Queues : sig ... end
Sourcemodule Filters : sig ... end

Contains the filter to apply when retrieving metrics.

Sourcemodule FiltersV2List : sig ... end
Sourcemodule FunctionArnsList : sig ... end
Sourcemodule URLExpiryInSeconds : sig ... end
Sourcemodule GetAttachedFileRequest : sig ... end

Request to GetAttachedFile API.

Sourcemodule GetAttachedFileResponse : sig ... end

Response from GetAttachedFile API.

Retrieves the contact attributes for the specified contact.

Retrieves the contact attributes for the specified contact.

Sourcemodule GetContactMetricsRequest : sig ... end

Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule GetContactMetricsResponse : sig ... end

Retrieves contact metric data for a specified contact. Use cases Following are common use cases for position in queue and estimated wait time: Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. Important things to know Metrics are only available while the contact is actively in queue. For more information, see the Position in queue metric in the Amazon Connect Administrator Guide. Endpoints: See Amazon Connect endpoints and quotas.

Sourcemodule Grouping : sig ... end
Sourcemodule Groupings : sig ... end

Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Add filters to reduce the amount of data returned

Gets the real-time metric data from the specified Amazon Connect instance. For a description of each metric, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Add filters to reduce the amount of data returned

Sourcemodule UserDataHierarchyGroups : sig ... end
Sourcemodule UserDataFilters : sig ... end

A filter for the user data.

Sourcemodule GetCurrentUserDataRequest : sig ... end

Gets the real-time active user data from the specified Amazon Connect instance.

Sourcemodule UserReference : sig ... end

Information about the user.

Information about the hierarchy group.

Sourcemodule HierarchyPathReference : sig ... end

Information about the levels in the hierarchy group.

Sourcemodule UserData : sig ... end

Data for a user.

Sourcemodule UserDataList : sig ... end

Gets the real-time active user data from the specified Amazon Connect instance.

Get the hours of operations with the effective override applied.

Get the hours of operations with the effective override applied.

Sourcemodule GetFederationTokenRequest : sig ... end

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Sourcemodule UserNotFoundException : sig ... end

No user with the specified credentials was found in the Amazon Connect instance.

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with IAM for Amazon Connect in the Amazon Connect Administrator Guide. This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect

Sourcemodule GetFlowAssociationRequest : sig ... end

Retrieves the flow associated for a given resource.

Retrieves the flow associated for a given resource.

Sourcemodule ThresholdValue : sig ... end
Sourcemodule Threshold : sig ... end

Contains information about the threshold for service level metrics.

Sourcemodule Statistic : sig ... end
Sourcemodule HistoricalMetricName : sig ... end
Sourcemodule HistoricalMetric : sig ... end

Contains information about a historical metric.

Sourcemodule HistoricalMetrics : sig ... end
Sourcemodule GetMetricDataRequest : sig ... end

Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

Sourcemodule HistoricalMetricData : sig ... end

Contains the data for a historical metric.

Sourcemodule HistoricalMetricResult : sig ... end

Contains information about the historical metrics retrieved.

Sourcemodule HistoricalMetricResults : sig ... end
Sourcemodule GetMetricDataResponse : sig ... end

Gets historical metric data from the specified Amazon Connect instance. For a description of each historical metric, see Metrics definitions in the Amazon Connect Administrator Guide. We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

Sourcemodule NextToken2500 : sig ... end
Sourcemodule ThresholdV2 : sig ... end

Contains information about the threshold for service level metrics.

Sourcemodule ThresholdCollections : sig ... end
Sourcemodule MetricNameV2 : sig ... end
Sourcemodule MetricId : sig ... end
Sourcemodule MetricFilterValueList : sig ... end
Sourcemodule MetricFilterV2 : sig ... end

Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.

Sourcemodule MetricFiltersV2List : sig ... end
Sourcemodule MetricV2 : sig ... end

Contains information about the metric. Only one of either the Name or MetricId is required.

Sourcemodule MetricsV2 : sig ... end
Sourcemodule IntervalPeriod : sig ... end
Sourcemodule IntervalDetails : sig ... end

Information about the interval period to use for returning results.

Sourcemodule GroupingV2 : sig ... end
Sourcemodule GroupingsV2 : sig ... end
Sourcemodule GetMetricDataV2Request : sig ... end

Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Narrow the time range of your request Add filters to reduce the amount of data returned

Sourcemodule MetricInterval : sig ... end

The interval period with the start and end time for the metrics.

Sourcemodule MetricDataV2 : sig ... end

Contains the name, thresholds, and metric filters.

Sourcemodule MetricDataCollectionsV2 : sig ... end
Sourcemodule MetricResultV2 : sig ... end

Contains information about the metric results.

Sourcemodule MetricResultsV2 : sig ... end
Sourcemodule GetMetricDataV2Response : sig ... end

Gets metric data from the specified Amazon Connect instance. GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide. When you make a successful API request, you can expect the following metric values in the response: Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data Metric value is a number (including 0) of defined type: The number provided is the calculation result MetricResult list is empty: The request cannot find any data in the system The following guidelines can help you work with the API: Each dimension in the metric response must contain a value Each item in MetricResult must include all requested metrics If the response is slow due to large result sets, try these approaches: Narrow the time range of your request Add filters to reduce the amount of data returned

Sourcemodule GetPromptFileRequest : sig ... end

Gets the prompt file.

Sourcemodule PromptPresignedUrl : sig ... end
Sourcemodule GetPromptFileResponse : sig ... end

Gets the prompt file.

Sourcemodule SnapshotVersion : sig ... end
Sourcemodule GetTaskTemplateRequest : sig ... end

Gets details about a specific task template in the specified Amazon Connect instance.

Sourcemodule GetTaskTemplateResponse : sig ... end

Gets details about a specific task template in the specified Amazon Connect instance.

Sourcemodule TestCaseExecutionId : sig ... end

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

Sourcemodule TestCaseExecutionStatus : sig ... end
Sourcemodule ObservationSummary : sig ... end

Contains summary statistics about a test case execution.

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

Retrieves the current traffic distribution for a given traffic distribution group.

Sourcemodule TelephonyConfig : sig ... end

The distribution of traffic between the instance and its replicas.

Sourcemodule SignInDistribution : sig ... end

The distribution of sign in traffic between the instance and its replica(s).

Sourcemodule SignInDistributionList : sig ... end
Sourcemodule SignInConfig : sig ... end

The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).

Retrieves the current traffic distribution for a given traffic distribution group.

Sourcemodule HierarchyGroupSummaryList : sig ... end
Sourcemodule HierarchyLevelUpdate : sig ... end

Contains information about the hierarchy level to update.

Sourcemodule HierarchyStructureUpdate : sig ... end

Contains information about the level hierarchy to update.

Sourcemodule HoursOfOperationList : sig ... end
Sourcemodule HoursOfOperationName : sig ... end

The search criteria to be used to return hours of operations overrides.

module HoursOfOperationSearchCriteria : sig ... end

The search criteria to be used to return hours of operations.

Filters to be applied to search results.

Sourcemodule HoursOfOperationSummary : sig ... end

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

Sourcemodule ImportPhoneNumberRequest : sig ... end

Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

Sourcemodule ImportPhoneNumberResponse : sig ... end

Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. Call the DescribePhoneNumber API to verify the status of a previous ImportPhoneNumber operation. If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket.

Sourcemodule MediaSource : sig ... end

Imports a media asset (such as a logo) for use in a workspace.

Imports a media asset (such as a logo) for use in a workspace.

Information about the additional TO and CC recipients of an inbound email contact. You can include up to 50 email addresses in total, distributed across DestinationEmailAddress, ToAddresses, and CcAddresses. This total must include one required DestinationEmailAddress. You can then specify up to 49 addresses allocated across ToAddresses and CcAddresses as needed.

Sourcemodule InboundSubject : sig ... end
Sourcemodule InboundRawMessage : sig ... end

Information about the raw email body content.

Sourcemodule InboundMessageSourceType : sig ... end
Sourcemodule InboundEmailContent : sig ... end

Information about email body content.

Sourcemodule InitiationMethodList : sig ... end
Sourcemodule InstanceStorageConfigs : sig ... end
Sourcemodule InstanceSummary : sig ... end

Information about the instance.

Sourcemodule InstanceSummaryList : sig ... end

Contains summary information about the associated AppIntegrations.

This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.

Sourcemodule IvrRecordingTrack : sig ... end
Sourcemodule LargeNextToken : sig ... end
Sourcemodule LexBotConfig : sig ... end

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

Sourcemodule LexBotConfigList : sig ... end
Sourcemodule LexBotsList : sig ... end
Sourcemodule LexVersion : sig ... end
Sourcemodule MaxResult1000 : sig ... end
Sourcemodule ListAgentStatusRequest : sig ... end

Lists agent statuses.

Sourcemodule ListAgentStatusResponse : sig ... end

Lists agent statuses.

Lists the association status of requested dataset ID for a given Amazon Connect instance.

Lists the association status of requested dataset ID for a given Amazon Connect instance.

Lists the data lake datasets available to associate with for a given Amazon Connect instance.

Lists the data lake datasets available to associate with for a given Amazon Connect instance.

Sourcemodule MaxResult25 : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.

Sourcemodule OriginsList : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all approved origins associated with the instance.

Provides information about contact tree, a list of associated contacts with a unique identifier.

Provides information about contact tree, a list of associated contacts with a unique identifier.

Provides summary information about the attached files configurations for the specified Amazon Connect instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.

Provides summary information about the attached files configurations for the specified Amazon Connect instance. This API returns effective configurations (custom overrides or defaults) for each attachment scope. If no custom configuration exists for a scope, the default configuration values are returned.

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. Provides summary information about the authentication profiles in a specified Amazon Connect instance.

Sourcemodule ListBotsRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

Sourcemodule ListBotsResponse : sig ... end

This API is in preview release for Amazon Connect and is subject to change. For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.

Provides information about the child hours of operations for the specified parent hours of operation. For more information about child hours of operations, see Link overrides from different hours of operation in the Administrator Guide.

Sourcemodule TargetListType : sig ... end
Sourcemodule ListCondition : sig ... end

A leaf node condition which can be used to specify a List condition to search users with attributes included in Lists like Proficiencies.

Lists contact evaluations in the specified Amazon Connect instance.

Lists contact evaluations in the specified Amazon Connect instance.

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

Retrieves a paginated list of all versions for a specific contact flow module.

Retrieves a paginated list of all versions for a specific contact flow module.

Provides information about the flow modules for the specified Amazon Connect instance.

Provides information about the flow modules for the specified Amazon Connect instance.

Returns all the available versions for the specified Amazon Connect instance and flow identifier.

Returns all the available versions for the specified Amazon Connect instance and flow identifier.

Sourcemodule ListContactFlowsRequest : sig ... end

Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Sourcemodule ListContactFlowsResponse : sig ... end

Provides information about the flows for the specified Amazon Connect instance. You can also create and update flows using the Amazon Connect Flow language. For more information about flows, see Flows in the Amazon Connect Administrator Guide.

Sourcemodule ReferenceTypes : sig ... end

This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Sourcemodule UrlReference : sig ... end

The URL reference.

Sourcemodule StringReference : sig ... end

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

Sourcemodule NumberReference : sig ... end

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

Sourcemodule ReferenceSummary : sig ... end

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

Sourcemodule ReferenceSummaryList : sig ... end

This API is in preview release for Amazon Connect and is subject to change. For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

Sourcemodule RecordIds : sig ... end
Sourcemodule ValueList : sig ... end

A primary attribute value filter.

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

Sourcemodule RecordPrimaryValue : sig ... end

A record primary value.

Sourcemodule PrimaryValuesList : sig ... end

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

Sourcemodule ListDataTablesRequest : sig ... end

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

Sourcemodule ListDataTablesResponse : sig ... end

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

Sourcemodule VocabularyNextToken : sig ... end

Lists the default vocabularies for the specified Amazon Connect instance.

Lists the default vocabularies for the specified Amazon Connect instance.

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

Sourcemodule SecurityProfiles100 : sig ... end

Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.

Lists versions of an evaluation form in the specified Amazon Connect instance.

Lists versions of an evaluation form in the specified Amazon Connect instance.

Lists evaluation forms in the specified Amazon Connect instance.

Lists evaluation forms in the specified Amazon Connect instance.

List the flow association based on the filters.

List the flow association based on the filters.

List the hours of operation overrides.

List the hours of operation overrides.

Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Sourcemodule MaxResult7 : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance.

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all attribute types for the given instance.

Sourcemodule MaxResult10 : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of storage configs for the identified instance and resource type.

Sourcemodule ListInstancesRequest : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Sourcemodule ListInstancesResponse : sig ... end

This API is in preview release for Amazon Connect and is subject to change. Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

This API is in preview release for Amazon Connect and is subject to change. Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.