Contains image configuration for a workspace theme.
* @public */ export interface WorkspaceThemeImages { /** *The logo images used in the workspace.
* @public */ Logo?: ImagesLogo | undefined; } /** *Contains color configuration for canvas elements in a workspace theme.
* @public */ export interface PaletteCanvas { /** *The background color for container elements.
* @public */ ContainerBackground?: string | undefined; /** *The background color for page elements.
* @public */ PageBackground?: string | undefined; /** *The background color for active elements.
* @public */ ActiveBackground?: string | undefined; } /** *Contains color configuration for header elements in a workspace theme.
* @public */ export interface PaletteHeader { /** *The background color of the header.
* @public */ Background?: string | undefined; /** *The text color in the header.
* @public */ Text?: string | undefined; /** *The text color when hovering over header elements.
* @public */ TextHover?: string | undefined; /** *Whether to invert the colors of action buttons in the header.
* @public */ InvertActionsColors?: boolean | undefined; } /** *Contains color configuration for navigation elements in a workspace theme.
* @public */ export interface PaletteNavigation { /** *The background color of the navigation area.
* @public */ Background?: string | undefined; /** *The background color when hovering over navigation text.
* @public */ TextBackgroundHover?: string | undefined; /** *The background color for active navigation items.
* @public */ TextBackgroundActive?: string | undefined; /** *The text color in the navigation area.
* @public */ Text?: string | undefined; /** *The text color when hovering over navigation items.
* @public */ TextHover?: string | undefined; /** *The text color for active navigation items.
* @public */ TextActive?: string | undefined; /** *Whether to invert the colors of action buttons in the navigation area.
* @public */ InvertActionsColors?: boolean | undefined; } /** *Contains primary color configuration for a workspace theme.
* @public */ export interface PalettePrimary { /** *The default primary color used throughout the workspace.
* @public */ Default?: string | undefined; /** *The primary color used for active states.
* @public */ Active?: string | undefined; /** *The text color that contrasts with the primary color for readability.
* @public */ ContrastText?: string | undefined; } /** *Contains color palette configuration for different areas of a workspace.
* @public */ export interface WorkspaceThemePalette { /** *The color configuration for the header area.
* @public */ Header?: PaletteHeader | undefined; /** *The color configuration for the navigation area.
* @public */ Navigation?: PaletteNavigation | undefined; /** *The color configuration for the canvas area.
* @public */ Canvas?: PaletteCanvas | undefined; /** *The primary color configuration used throughout the workspace.
* @public */ Primary?: PalettePrimary | undefined; } /** *Contains font family configuration for workspace themes.
* @public */ export interface FontFamily { /** *The default font family to use in the workspace theme.
* @public */ Default?: WorkspaceFontFamily | undefined; } /** *Contains typography configuration for a workspace theme.
* @public */ export interface WorkspaceThemeTypography { /** *The font family configuration for text in the workspace.
* @public */ FontFamily?: FontFamily | undefined; } /** *Contains detailed theme configuration for a workspace, including colors, images, and typography.
* @public */ export interface WorkspaceThemeConfig { /** *The color palette configuration for the workspace theme.
* @public */ Palette?: WorkspaceThemePalette | undefined; /** *The image assets used in the workspace theme.
* @public */ Images?: WorkspaceThemeImages | undefined; /** *The typography configuration for the workspace theme.
* @public */ Typography?: WorkspaceThemeTypography | undefined; } /** *Contains theme configuration for a workspace, supporting both light and dark modes.
* @public */ export interface WorkspaceTheme { /** *The theme configuration for light mode.
* @public */ Light?: WorkspaceThemeConfig | undefined; /** *The theme configuration for dark mode.
* @public */ Dark?: WorkspaceThemeConfig | undefined; } /** * @public */ export interface CreateWorkspaceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The name of the workspace. Must be unique within the instance and can contain 1-127 characters.
* @public */ Name: string | undefined; /** *The description of the workspace. Maximum length is 250 characters.
* @public */ Description?: string | undefined; /** *The theme configuration for the workspace, including colors and styling.
* @public */ Theme?: WorkspaceTheme | undefined; /** *The title displayed for the workspace.
* @public */ Title?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags":
* \{"key1":"value1", "key2":"value2"\} \}.
The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; /** *The Amazon Resource Name (ARN) of the workspace.
* @public */ WorkspaceArn: string | undefined; } /** * @public */ export interface CreateWorkspacePageRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; /** *The Amazon Resource Name (ARN) of the view to associate with the page.
* @public */ ResourceArn: string | undefined; /** *The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom
* pages cannot use the aws: or connect: prefixes.
The URL-friendly identifier for the page.
* @public */ Slug?: string | undefined; /** *A JSON string containing input parameters for the view, validated against the view's input schema.
* @public */ InputData?: string | undefined; } /** * @public */ export interface CreateWorkspacePageResponse { } /** * @public */ export interface DeactivateEvaluationFormRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is * deactivated.
* @public */ EvaluationFormVersion: number | undefined; } /** * @public */ export interface DeactivateEvaluationFormResponse { /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *The Amazon Resource Name (ARN) for the evaluation form resource.
* @public */ EvaluationFormArn: string | undefined; /** *The version of the deactivated evaluation form resource.
* @public */ EvaluationFormVersion: number | undefined; } /** * Request to DeleteAttachedFile API * @public */ export interface DeleteAttachedFileRequest { /** *The unique identifier of the Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier of the attached file resource.
* @public */ FileId: string | undefined; /** *The resource to which the attached file is (being) uploaded to. Cases are the only current supported * resource.
*This value must be a valid ARN.
*The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; } /** * @public */ export interface DeleteContactFlowRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; } /** * @public */ export interface DeleteContactFlowResponse { } /** * @public */ export interface DeleteContactFlowModuleRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; } /** * @public */ export interface DeleteContactFlowModuleResponse { } /** * @public */ export interface DeleteContactFlowModuleAliasRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; /** *The identifier of the alias.
* @public */ AliasId: string | undefined; } /** * @public */ export interface DeleteContactFlowModuleAliasResponse { } /** * @public */ export interface DeleteContactFlowModuleVersionRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; /** *The version of the flow module to delete.
* @public */ ContactFlowModuleVersion: number | undefined; } /** * @public */ export interface DeleteContactFlowModuleVersionResponse { } /** * @public */ export interface DeleteContactFlowVersionRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; /** *The identifier of the flow version.
* @public */ ContactFlowVersion: number | undefined; } /** * @public */ export interface DeleteContactFlowVersionResponse { } /** * @public */ export interface DeleteDataTableRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the * version is provided and is not $LATEST.
* @public */ DataTableId: string | undefined; } /** * @public */ export interface DeleteDataTableResponse { } /** * @public */ export interface DeleteDataTableAttributeRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table.
* @public */ DataTableId: string | undefined; /** *The name of the attribute to delete.
* @public */ AttributeName: string | undefined; } /** * @public */ export interface DeleteDataTableAttributeResponse { /** *The updated lock version of the data table.
* @public */ LockVersion: DataTableLockVersion | undefined; } /** * @public */ export interface DeleteEmailAddressRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the email address.
* @public */ EmailAddressId: string | undefined; } /** * @public */ export interface DeleteEmailAddressResponse { } /** * @public */ export interface DeleteEvaluationFormRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormVersion?: number | undefined; } /** * @public */ export interface DeleteHoursOfOperationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; } /** * @public */ export interface DeleteHoursOfOperationOverrideRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The identifier for the hours of operation override.
* @public */ HoursOfOperationOverrideId: string | undefined; } /** * @public */ export interface DeleteInstanceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DeleteIntegrationAssociationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the integration association.
* @public */ IntegrationAssociationId: string | undefined; } /** * @public */ export interface DeleteNotificationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the notification to delete.
* @public */ NotificationId: string | undefined; } /** *The response from deleting a notification.
* @public */ export interface DeleteNotificationResponse { } /** * @public */ export interface DeletePredefinedAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance.
* @public */ InstanceId: string | undefined; /** *The name of the predefined attribute.
* @public */ Name: string | undefined; } /** * @public */ export interface DeletePromptRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the prompt.
* @public */ PromptId: string | undefined; } /** * @public */ export interface DeletePushNotificationRegistrationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name * (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the registration.
* @public */ RegistrationId: string | undefined; /** *The identifier of the contact within the Amazon Connect instance.
* @public */ ContactId: string | undefined; } /** * @public */ export interface DeletePushNotificationRegistrationResponse { } /** * @public */ export interface DeleteQueueRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the queue.
* @public */ QueueId: string | undefined; } /** * @public */ export interface DeleteQuickConnectRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the quick connect.
* @public */ QuickConnectId: string | undefined; } /** * @public */ export interface DeleteRoutingProfileRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the routing profile.
* @public */ RoutingProfileId: string | undefined; } /** * @public */ export interface DeleteRuleRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the rule.
* @public */ RuleId: string | undefined; } /** * @public */ export interface DeleteSecurityProfileRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the security profle.
* @public */ SecurityProfileId: string | undefined; } /** * @public */ export interface DeleteTaskTemplateRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the task template.
* @public */ TaskTemplateId: string | undefined; } /** * @public */ export interface DeleteTaskTemplateResponse { } /** * @public */ export interface DeleteTestCaseRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case to delete.
* @public */ TestCaseId: string | undefined; } /** * @public */ export interface DeleteTestCaseResponse { } /** * @public */ export interface DeleteTrafficDistributionGroupRequest { /** *The identifier of the traffic distribution group. * This can be the ID or the ARN of the traffic distribution group.
* @public */ TrafficDistributionGroupId: string | undefined; } /** * @public */ export interface DeleteTrafficDistributionGroupResponse { } /** * @public */ export interface DeleteUseCaseRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the integration association.
* @public */ IntegrationAssociationId: string | undefined; /** *The identifier for the use case.
* @public */ UseCaseId: string | undefined; } /** * @public */ export interface DeleteUserRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the user.
* @public */ UserId: string | undefined; } /** * @public */ export interface DeleteUserHierarchyGroupRequest { /** *The identifier of the hierarchy group.
* @public */ HierarchyGroupId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface DeleteViewRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the * instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the view. Both ViewArn and ViewId can be used.
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the * instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the view. Both ViewArn and ViewId can be used.
The version number of the view.
* @public */ ViewVersion: number | undefined; } /** * @public */ export interface DeleteViewVersionResponse { } /** * @public */ export interface DeleteVocabularyRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the custom vocabulary.
* @public */ VocabularyId: string | undefined; } /** * @public */ export interface DeleteVocabularyResponse { /** *The Amazon Resource Name (ARN) of the custom vocabulary.
* @public */ VocabularyArn: string | undefined; /** *The identifier of the custom vocabulary.
* @public */ VocabularyId: string | undefined; /** *The current state of the custom vocabulary.
* @public */ State: VocabularyState | undefined; } /** * @public */ export interface DeleteWorkspaceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; } /** * @public */ export interface DeleteWorkspaceResponse { } /** * @public */ export interface DeleteWorkspaceMediaRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; /** *The type of media to delete. Valid values are: IMAGE_LOGO_FAVICON and
* IMAGE_LOGO_HORIZONTAL.
The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; /** *The page identifier.
* @public */ Page: string | undefined; } /** * @public */ export interface DeleteWorkspacePageResponse { } /** * @public */ export interface DescribeAgentStatusRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the agent status.
* @public */ AgentStatusId: string | undefined; } /** * @public */ export interface DescribeAgentStatusResponse { /** *The agent status.
* @public */ AgentStatus?: AgentStatus | undefined; } /** * @public */ export interface DescribeAttachedFilesConfigurationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.
The configuration for allowed file extensions.
* @public */ export interface ExtensionConfiguration { /** *The list of allowed file extensions.
* @public */ AllowedExtensions: AllowedExtension[] | undefined; } /** *The configuration for attached files for a specific attachment scope.
* @public */ export interface AttachedFilesConfiguration { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.
The maximum size limit for attached files in bytes.
* @public */ MaximumSizeLimitInBytes?: number | undefined; /** *The configuration for allowed file extensions.
* @public */ ExtensionConfiguration?: ExtensionConfiguration | undefined; /** *The timestamp when the configuration was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface DescribeAttachedFilesConfigurationResponse { /** *Information about the attached files configuration.
* @public */ AttachedFilesConfiguration: AttachedFilesConfiguration | undefined; } /** * @public */ export interface DescribeAuthenticationProfileRequest { /** *A unique identifier for the authentication profile.
* @public */ AuthenticationProfileId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *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.
*Information about an authentication profile. An authentication profile is a resource that stores the * authentication settings for users in your contact center. You use authentication profiles to set up IP address range * restrictions and session timeouts. For more information, see Set IP address restrictions or session * timeouts.
* @public */ export interface AuthenticationProfile { /** *A unique identifier for the authentication profile.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) for the authentication profile.
* @public */ Arn?: string | undefined; /** *The name for the authentication profile.
* @public */ Name?: string | undefined; /** *The description for the authentication profile.
* @public */ Description?: string | undefined; /** *A list of IP address range strings that are allowed to access the Amazon Connect instance. For more * information about how to configure IP addresses, see Configure IP address based access * control in the Amazon Connect Administrator Guide.
* @public */ AllowedIps?: string[] | undefined; /** *A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more * information about how to configure IP addresses, see Configure IP address based access * control in the Amazon Connect Administrator Guide.
* @public */ BlockedIps?: string[] | undefined; /** *Shows whether the authentication profile is the default authentication profile for the Amazon Connect * instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless * overridden by another authentication profile.
* @public */ IsDefault?: boolean | undefined; /** *The timestamp when the authentication profile was created.
* @public */ CreatedTime?: Date | undefined; /** *The timestamp when the authentication profile was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where the authentication profile was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value * determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
* * @deprecated (since 10/31/2025) PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead. * @public */ PeriodicSessionDuration?: number | undefined; /** *The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, * users must log in again. For more information, see Configure the session * duration in the Amazon Connect Administrator Guide.
* @public */ MaxSessionDuration?: number | undefined; /** *The period, in minutes, before an agent is automatically signed out of the contact center when they go * inactive.
* @public */ SessionInactivityDuration?: number | undefined; /** *Determines if automatic logout on user inactivity is enabled.
* @public */ SessionInactivityHandlingEnabled?: boolean | undefined; } /** * @public */ export interface DescribeAuthenticationProfileResponse { /** *The authentication profile object being described.
* @public */ AuthenticationProfile?: AuthenticationProfile | undefined; } /** * @public */ export interface DescribeContactRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the contact.
* @public */ ContactId: string | undefined; } /** *Information about a participant's interactions in a contact.
* @public */ export interface ParticipantMetrics { /** *The Participant's ID.
* @public */ ParticipantId?: string | undefined; /** *Information about the conversation participant. Following are the participant types: [Agent, Customer, * Supervisor].
* @public */ ParticipantType?: ParticipantType | undefined; /** *A boolean flag indicating whether the chat conversation was abandoned by a Participant.
* @public */ ConversationAbandon?: boolean | undefined; /** *Number of chat messages sent by Participant.
* @public */ MessagesSent?: number | undefined; /** *Number of chat messages sent by Participant.
* @public */ NumResponses?: number | undefined; /** *Number of chat characters sent by Participant.
* @public */ MessageLengthInChars?: number | undefined; /** *Total chat response time by Participant.
* @public */ TotalResponseTimeInMillis?: number | undefined; /** *Maximum chat response time by Participant.
* @public */ MaxResponseTimeInMillis?: number | undefined; /** *Timestamp of last chat message by Participant.
* @public */ LastMessageTimestamp?: Date | undefined; } /** *Information about the overall participant interactions at the contact level.
* @public */ export interface ChatContactMetrics { /** *A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.
* @public */ MultiParty?: boolean | undefined; /** *The number of chat messages on the contact.
* @public */ TotalMessages?: number | undefined; /** *The total number of bot and automated messages on a chat contact.
* @public */ TotalBotMessages?: number | undefined; /** *The total number of characters from bot and automated messages on a chat contact.
* @public */ TotalBotMessageLengthInChars?: number | undefined; /** *The time it took for a contact to end after the last customer message.
* @public */ ConversationCloseTimeInMillis?: number | undefined; /** *The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between * customer and other participants.
* @public */ ConversationTurnCount?: number | undefined; /** *The agent first response timestamp for a chat contact.
* @public */ AgentFirstResponseTimestamp?: Date | undefined; /** *The time for an agent to respond after obtaining a chat contact.
* @public */ AgentFirstResponseTimeInMillis?: number | undefined; } /** *Information about how agent, bot, and customer interact in a chat contact.
* @public */ export interface ChatMetrics { /** *Information about the overall participant interactions at the contact level.
* @public */ ChatContactMetrics?: ChatContactMetrics | undefined; /** *Information about agent interactions in a contact.
* @public */ AgentMetrics?: ParticipantMetrics | undefined; /** *Information about customer interactions in a contact.
* @public */ CustomerMetrics?: ParticipantMetrics | undefined; } /** *A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. * This object is used only for task contacts.
* @public */ export interface ContactDetails { /** *The name of the contact details.
* @public */ Name?: string | undefined; /** *Teh description of the contact details.
* @public */ Description?: string | undefined; } /** *Information about the contact evaluations where the key is the FormId, which is a unique identifier for the * form.
* @public */ export interface ContactEvaluation { /** *The FormId of the contact evaluation.
The Amazon Resource Name for the evaluation form. It is always present.
* @public */ EvaluationArn?: string | undefined; /** *The status of the evaluation.
* @public */ Status?: Status | undefined; /** *The date and time when the evaluation was started, in UTC time.
* @public */ StartTimestamp?: Date | undefined; /** *The date and time when the evaluation was submitted, in UTC time.
* @public */ EndTimestamp?: Date | undefined; /** *The date and time when the evaluation was deleted, in UTC time.
* @public */ DeleteTimestamp?: Date | undefined; /** *The path where evaluation was exported.
* @public */ ExportLocation?: string | undefined; } /** *Information about the Customer on the contact.
* @public */ export interface Customer { /** *Information regarding Customer’s device.
* @public */ DeviceInfo?: DeviceInfo | undefined; /** *The configuration for the allowed video and screen sharing capabilities for participants present over the call. * For more information, see Set up * in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator * Guide.
* @public */ Capabilities?: ParticipantCapabilities | undefined; } /** *Information about the endpoint.
* @public */ export interface EndpointInfo { /** *Type of endpoint.
* @public */ Type?: EndpointType | undefined; /** *Address of the endpoint.
* @public */ Address?: string | undefined; /** *Display name of the endpoint.
* @public */ DisplayName?: string | undefined; } /** *Information about customer’s voice activity.
* @public */ export interface CustomerVoiceActivity { /** *Timestamp that measures the beginning of the customer greeting from an outbound voice call.
* @public */ GreetingStartTimestamp?: Date | undefined; /** *Timestamp that measures the end of the customer greeting from an outbound voice call.
* @public */ GreetingEndTimestamp?: Date | undefined; } /** *Information about the call disconnect experience.
* @public */ export interface DisconnectDetails { /** *Indicates the potential disconnection issues for a call. This field is not populated if the service does not * detect potential issues.
* @public */ PotentialDisconnectIssue?: string | undefined; } /** *Information about the global resiliency configuration for the contact, including traffic distribution details.
* @public */ export interface GlobalResiliencyMetadata { /** *The current AWS region in which the contact is active. This indicates where the contact is being processed in real-time.
* @public */ ActiveRegion?: string | undefined; /** *The AWS region where the contact was originally created and initiated. This may differ from the ActiveRegion if the contact has been transferred across regions.
* @public */ OriginRegion?: string | undefined; /** *The identifier of the traffic distribution group.
* @public */ TrafficDistributionGroupId?: string | undefined; } /** *Contact data associated with quick connect operations.
* @public */ export interface QuickConnectContactData { /** *The contact ID for quick connect contact data.
* @public */ ContactId?: string | undefined; /** *Timestamp when the quick connect contact was initiated.
* @public */ InitiationTimestamp?: Date | undefined; /** *The quick connect ID.
* @public */ QuickConnectId?: string | undefined; /** *The name of the quick connect.
* @public */ QuickConnectName?: string | undefined; /** *The type of the quick connect.
* @public */ QuickConnectType?: QuickConnectType | undefined; } /** *Metadata information for next contact.
* @public */ export type NextContactMetadata = NextContactMetadata.QuickConnectContactDataMember | NextContactMetadata.$UnknownMember; /** * @public */ export declare namespace NextContactMetadata { /** *Quick connect contact data for the next contact metadata.
* @public */ interface QuickConnectContactDataMember { QuickConnectContactData: QuickConnectContactData; $unknown?: never; } /** * @public */ interface $UnknownMember { QuickConnectContactData?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorEntry representing the next contact in a sequence.
* @public */ export interface NextContactEntry { /** *The type of the next contact entry.
* @public */ Type?: NextContactType | undefined; /** *Metadata for the next contact entry.
* @public */ NextContactMetadata?: NextContactMetadata | undefined; } /** *Information about the quality of the Customer's media connection
* @public */ export interface CustomerQualityMetrics { /** *Information about the audio quality of the Customer
* @public */ Audio?: AudioQualityMetricsInfo | undefined; } /** *Information about the quality of the participant's media connection.
* @public */ export interface QualityMetrics { /** *Information about the quality of Agent media connection.
* @public */ Agent?: AgentQualityMetrics | undefined; /** *Information about the quality of Customer media connection.
* @public */ Customer?: CustomerQualityMetrics | undefined; } /** *If this contact was queued, this contains information about the queue.
* @public */ export interface QueueInfo { /** *The unique identifier for the queue.
* @public */ Id?: string | undefined; /** *The timestamp when the contact was added to the queue.
* @public */ EnqueueTimestamp?: Date | undefined; } /** *Information about a voice recording, chat transcript, or screen recording.
* @public */ export interface RecordingInfo { /** *Where the recording/transcript is stored.
* @public */ StorageType?: StorageType | undefined; /** *The location, in Amazon S3, for the recording/transcript.
* @public */ Location?: string | undefined; /** *Information about the media stream used during the conversation.
* @public */ MediaStreamType?: MediaStreamType | undefined; /** *Information about the conversation participant, whether they are an agent or contact. The participant types are * as follows:
*All
*Manager
*Agent
*Customer
*Thirdparty
*Supervisor
*The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
* @public */ FragmentStartNumber?: string | undefined; /** *The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
* @public */ FragmentStopNumber?: string | undefined; /** *When the conversation of the last leg of the recording started in UTC time.
* @public */ StartTimestamp?: Date | undefined; /** *When the conversation of the last leg of recording stopped in UTC time.
* @public */ StopTimestamp?: Date | undefined; /** *The status of the recording/transcript.
* @public */ Status?: RecordingStatus | undefined; /** *If the recording/transcript was deleted, this is the reason entered for the deletion.
* @public */ DeletionReason?: string | undefined; /** *The location, in Amazon S3, for the unprocessed transcript if any media processing was performed.
* @public */ UnprocessedTranscriptLocation?: string | undefined; } /** *An object to specify the expiration of a routing step.
* @public */ export interface Expiry { /** *The number of seconds to wait before expiring the routing step.
* @public */ DurationInSeconds?: number | undefined; /** *The timestamp indicating when the routing step expires.
* @public */ ExpiryTimestamp?: Date | undefined; } /** *An object to define AgentsCriteria.
* @public */ export interface MatchCriteria { /** *An object to define agentIds.
* @public */ AgentsCriteria?: AgentsCriteria | undefined; } /** *An Object to define the minimum and maximum proficiency levels.
* @public */ export interface Range { /** *The minimum proficiency level of the range.
* @public */ MinProficiencyLevel?: number | undefined; /** *The maximum proficiency level of the range.
* @public */ MaxProficiencyLevel?: number | undefined; } /** *An object to specify the predefined attribute condition.
* @public */ export interface AttributeCondition { /** *The name of predefined attribute.
* @public */ Name?: string | undefined; /** *The value of predefined attribute.
* @public */ Value?: string | undefined; /** *The proficiency level of the condition.
* @public */ ProficiencyLevel?: number | undefined; /** *An Object to define the minimum and maximum proficiency levels.
* @public */ Range?: Range | undefined; /** *An object to define AgentsCriteria.
The operator of the condition.
* @public */ ComparisonOperator?: string | undefined; } /** *Information about the task template used to create this contact.
* @public */ export interface TaskTemplateInfoV2 { /** *The Amazon Resource Name (ARN) of the task template used to create this contact.
* @public */ Arn?: string | undefined; /** *The name of the task template used to create this contact.
* @public */ Name?: string | undefined; } /** *Information about Amazon Connect Wisdom.
* @public */ export interface WisdomInfo { /** *The Amazon Resource Name (ARN) of the Wisdom session.
* @public */ SessionArn?: string | undefined; /** *The array of AI agents involved in the contact.
* @public */ AiAgents?: AiAgentInfo[] | undefined; } /** * @public */ export interface DescribeContactEvaluationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; } /** *The milliseconds offset for transcript reference in suggested answer.
* @public */ export interface EvaluationSuggestedAnswerTranscriptMillisecondOffsets { /** *Offset in milliseconds from the beginning of the transcript.
* @public */ BeginOffsetMillis: number | undefined; } /** *Information about the point of interest in transcript provided to evaluation.
* @public */ export interface EvaluationTranscriptPointOfInterest { /** *Offset in milliseconds from the beginning of transcript.
* @public */ MillisecondOffsets?: EvaluationSuggestedAnswerTranscriptMillisecondOffsets | undefined; /** *Segment of transcript.
* @public */ TranscriptSegment?: string | undefined; } /** *The Contact Lens category used by evaluation automation.
* @public */ export interface EvaluationAutomationRuleCategory { /** *A category label.
* @public */ Category: string | undefined; /** *An automation condition for a Contact Lens category.
* @public */ Condition: QuestionRuleCategoryAutomationCondition | undefined; /** *A point of interest in a contact transcript that indicates match of condition.
* @public */ PointsOfInterest?: EvaluationTranscriptPointOfInterest[] | undefined; } /** *Analysis details providing explanation for Contact Lens automation decision.
* @public */ export interface EvaluationContactLensAnswerAnalysisDetails { /** *A list of match rule categories.
* @public */ MatchedRuleCategories?: EvaluationAutomationRuleCategory[] | undefined; } /** *An analysis for a generative AI answer to the question.
* @public */ export interface EvaluationGenAIAnswerAnalysisDetails { /** *Generative AI automation answer justification.
* @public */ Justification?: string | undefined; /** *Generative AI automation answer analysis points of interest.
* @public */ PointsOfInterest?: EvaluationTranscriptPointOfInterest[] | undefined; } /** *Detailed analysis results of the automated answer to the evaluation question.
* @public */ export type EvaluationQuestionAnswerAnalysisDetails = EvaluationQuestionAnswerAnalysisDetails.ContactLensMember | EvaluationQuestionAnswerAnalysisDetails.GenAIMember | EvaluationQuestionAnswerAnalysisDetails.$UnknownMember; /** * @public */ export declare namespace EvaluationQuestionAnswerAnalysisDetails { /** *Analysis results from the generative AI automation for the question.
* @public */ interface GenAIMember { GenAI: EvaluationGenAIAnswerAnalysisDetails; ContactLens?: never; $unknown?: never; } /** *Analysis results from the Contact Lens automation for the question.
* @public */ interface ContactLensMember { GenAI?: never; ContactLens: EvaluationContactLensAnswerAnalysisDetails; $unknown?: never; } /** * @public */ interface $UnknownMember { GenAI?: never; ContactLens?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorDetails of the input data used for automated question processing.
* @public */ export interface EvaluationQuestionInputDetails { /** *Transcript type.
* @public */ TranscriptType?: EvaluationTranscriptType | undefined; } /** *Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not * applicable.
* @public */ export type EvaluationAnswerData = EvaluationAnswerData.DateTimeValueMember | EvaluationAnswerData.NotApplicableMember | EvaluationAnswerData.NumericValueMember | EvaluationAnswerData.StringValueMember | EvaluationAnswerData.StringValuesMember | EvaluationAnswerData.$UnknownMember; /** * @public */ export declare namespace EvaluationAnswerData { /** *The string value for an answer in a contact evaluation.
* @public */ interface StringValueMember { StringValue: string; NumericValue?: never; StringValues?: never; DateTimeValue?: never; NotApplicable?: never; $unknown?: never; } /** *The numeric value for an answer in a contact evaluation.
* @public */ interface NumericValueMember { StringValue?: never; NumericValue: number; StringValues?: never; DateTimeValue?: never; NotApplicable?: never; $unknown?: never; } /** *String values provided as answers to evaluation questions.
* @public */ interface StringValuesMember { StringValue?: never; NumericValue?: never; StringValues: string[]; DateTimeValue?: never; NotApplicable?: never; $unknown?: never; } /** *Date and time value provided as an answer to an evaluation question.
* @public */ interface DateTimeValueMember { StringValue?: never; NumericValue?: never; StringValues?: never; DateTimeValue: string; NotApplicable?: never; $unknown?: never; } /** *The flag to mark the question as not applicable.
* @public */ interface NotApplicableMember { StringValue?: never; NumericValue?: never; StringValues?: never; DateTimeValue?: never; NotApplicable: boolean; $unknown?: never; } /** * @public */ interface $UnknownMember { StringValue?: never; NumericValue?: never; StringValues?: never; DateTimeValue?: never; NotApplicable?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe information about the suggested answer for the question.
* @public */ export interface EvaluationSuggestedAnswer { /** *Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not * applicable.
* @public */ Value?: EvaluationAnswerData | undefined; /** *The status of the suggested answer. D
* @public */ Status: EvaluationSuggestedAnswerStatus | undefined; /** *Details about the input used to question automation.
* @public */ Input?: EvaluationQuestionInputDetails | undefined; /** *Type of analysis used to provide suggested answer.
* @public */ AnalysisType: EvaluationQuestionAnswerAnalysisType | undefined; /** *Detailed analysis results.
* @public */ AnalysisDetails?: EvaluationQuestionAnswerAnalysisDetails | undefined; } /** *Information about output answers for a contact evaluation.
* @public */ export interface EvaluationAnswerOutput { /** *The value for an answer in a contact evaluation.
* @public */ Value?: EvaluationAnswerData | undefined; /** *The system suggested value for an answer in a contact evaluation.
* @public */ SystemSuggestedValue?: EvaluationAnswerData | undefined; /** *Automation suggested answers for the questions.
* @public */ SuggestedAnswers?: EvaluationSuggestedAnswer[] | undefined; } /** *Information about the evaluation acknowledgement.
* @public */ export interface EvaluationAcknowledgement { /** *When the agent acknowledged the evaluation.
* @public */ AcknowledgedTime: Date | undefined; /** *The agent who acknowledged the evaluation.
* @public */ AcknowledgedBy: string | undefined; /** *A comment from the agent when they confirmed they acknowledged the evaluation.
* @public */ AcknowledgerComment?: string | undefined; } /** *Details about automated evaluations.
* @public */ export interface AutoEvaluationDetails { /** *Whether automated evaluation is enabled.
* @public */ AutoEvaluationEnabled: boolean | undefined; /** *The status of the contact auto-evaluation.
* @public */ AutoEvaluationStatus?: AutoEvaluationStatus | undefined; } /** *Information about a contact participant in the evaluation.
* @public */ export interface EvaluationContactParticipant { /** *The role of the contact participant.
* @public */ ContactParticipantRole?: ContactParticipantRole | undefined; /** *The identifier for the contact participant.
* @public */ ContactParticipantId?: string | undefined; } /** *A comment provided when requesting an evaluation review.
* @public */ export interface EvaluationReviewRequestComment { /** *The text content of the review request comment.
* @public */ Comment?: string | undefined; /** *The timestamp when the evaluation review request comment was created.
* @public */ CreatedTime?: Date | undefined; /** *The user who created the evaluation review request comment.
* @public */ CreatedBy?: string | undefined; } /** *Metadata information about an evaluation review.
* @public */ export interface EvaluationReviewMetadata { /** *The unique identifier for the evaluation review.
* @public */ ReviewId?: string | undefined; /** *The timestamp when the evaluation review was requested.
* @public */ RequestedTime?: Date | undefined; /** *The user who requested the evaluation review.
* @public */ RequestedBy?: string | undefined; /** *The timestamp when the evaluation review was created.
* * @deprecated (since 02/17/2026) CreatedTime is deprecated. * @public */ CreatedTime?: Date | undefined; /** *The user who created the evaluation review.
* * @deprecated (since 02/17/2026) CreatedBy is deprecated. * @public */ CreatedBy?: string | undefined; /** *Comments provided when requesting the evaluation review.
* @public */ ReviewRequestComments: EvaluationReviewRequestComment[] | undefined; } /** *Information about scores of a contact evaluation item (section or question).
* @public */ export interface EvaluationScore { /** *The score percentage for an item in a contact evaluation.
* @public */ Percentage?: number | undefined; /** *The flag to mark the item as not applicable for scoring.
* @public */ NotApplicable?: boolean | undefined; /** *The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this * flag will be true.
* @public */ AutomaticFail?: boolean | undefined; /** *Weight applied to this evaluation score.
* @public */ AppliedWeight?: number | undefined; } /** *Metadata information about a contact evaluation.
* @public */ export interface EvaluationMetadata { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: string | undefined; /** *The Amazon Resource Name (ARN) of the user who last updated the evaluation.
* @public */ EvaluatorArn: string | undefined; /** *The identifier of the agent who performed the contact.
* @public */ ContactAgentId?: string | undefined; /** *The calibration session ID that this evaluation belongs to.
* @public */ CalibrationSessionId?: string | undefined; /** *The overall score of the contact evaluation.
* @public */ Score?: EvaluationScore | undefined; /** *Information related to automated evaluation.
* @public */ AutoEvaluation?: AutoEvaluationDetails | undefined; /** *Information related to evaluation acknowledgement.
* @public */ Acknowledgement?: EvaluationAcknowledgement | undefined; /** *Information about reviews of this evaluation.
* @public */ Review?: EvaluationReviewMetadata | undefined; /** *Information about a contact participant in this evaluation.
* @public */ ContactParticipant?: EvaluationContactParticipant | undefined; /** *Identifier of the sampling job.
* @public */ SamplingJobId?: string | undefined; } /** *Information about notes for a contact evaluation.
* @public */ export interface EvaluationNote { /** *The note for an item (section or question) in a contact evaluation.
*Even though a note in an evaluation can have up to 3072 chars, there is also a limit on the total number of * chars for all the notes in the evaluation combined. Assuming there are N questions in the evaluation being * submitted, then the max char limit for all notes combined is N x 1024.
*Information about a contact evaluation.
* @public */ export interface Evaluation { /** *A unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; /** *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ EvaluationArn: string | undefined; /** *Metadata about the contact evaluation.
* @public */ Metadata: EvaluationMetadata | undefined; /** *A map of question identifiers to answer value.
* @public */ Answers: RecordA map of question identifiers to note value.
* @public */ Notes: RecordThe status of the contact evaluation.
* @public */ Status: EvaluationStatus | undefined; /** *A map of item (section or question) identifiers to score value.
* @public */ Scores?: RecordThe timestamp for when the evaluation was created.
* @public */ CreatedTime: Date | undefined; /** *The timestamp for when the evaluation was last updated.
* @public */ LastModifiedTime: Date | undefined; /** *Type of the evaluation.
* @public */ EvaluationType?: EvaluationType | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; } /** *Contains information about a flow.
* @public */ export interface ContactFlow { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ Arn?: string | undefined; /** *The identifier of the flow.
* @public */ Id?: string | undefined; /** *The name of the flow.
* @public */ Name?: string | undefined; /** *The type of the flow. For descriptions of the available types, see Choose a flow type in the * Amazon Connect Administrator Guide.
* @public */ Type?: ContactFlowType | undefined; /** *The type of flow.
* @public */ State?: ContactFlowState | undefined; /** *The status of the flow.
* @public */ Status?: ContactFlowStatus | undefined; /** *The description of the flow.
* @public */ Description?: string | undefined; /** *The JSON string that represents the content of the flow. For an example, see Example * flow in Amazon Connect Flow language.
*Length Constraints: Minimum length of 1. Maximum length of 256000.
* @public */ Content?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordIndicates the checksum value of the flow content.
* @public */ FlowContentSha256?: string | undefined; /** *The identifier of the flow version.
* @public */ Version?: number | undefined; /** *The description of the flow version.
* @public */ VersionDescription?: string | undefined; /** *The time at which the flow was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The region in which the flow was last modified
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeContactFlowResponse { /** *Information about the flow.
* @public */ ContactFlow?: ContactFlow | undefined; } /** * @public */ export interface DescribeContactFlowModuleRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; } /** *Contains information about a flow module.
* @public */ export interface ContactFlowModule { /** *The Amazon Resource Name (ARN).
* @public */ Arn?: string | undefined; /** *The identifier of the flow module.
* @public */ Id?: string | undefined; /** *The name of the flow module.
* @public */ Name?: string | undefined; /** *The JSON string that represents the content of the flow. For an example, see Example * flow in Amazon Connect Flow language.
* @public */ Content?: string | undefined; /** *The description of the flow module.
* @public */ Description?: string | undefined; /** *The type of flow module.
* @public */ State?: ContactFlowModuleState | undefined; /** *The status of the flow module.
* @public */ Status?: ContactFlowModuleStatus | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordHash of the module content for integrity verification.
* @public */ FlowModuleContentSha256?: string | undefined; /** *The version of the flow module.
* @public */ Version?: number | undefined; /** *Description of the version.
* @public */ VersionDescription?: string | undefined; /** *The configuration settings for the flow module.
* @public */ Settings?: string | undefined; /** *The external invocation configuration for the flow module
* @public */ ExternalInvocationConfiguration?: ExternalInvocationConfiguration | undefined; } /** * @public */ export interface DescribeContactFlowModuleResponse { /** *Information about the flow module.
* @public */ ContactFlowModule?: ContactFlowModule | undefined; } /** * @public */ export interface DescribeContactFlowModuleAliasRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; /** *The identifier of the alias.
* @public */ AliasId: string | undefined; } /** *Contains information about an alias.
* @public */ export interface ContactFlowModuleAliasInfo { /** *The identifier of the flow module.
* @public */ ContactFlowModuleId?: string | undefined; /** *The Amazon Resource Name (ARN) of the flow module.
* @public */ ContactFlowModuleArn?: string | undefined; /** *The identifier of the alias.
* @public */ AliasId?: string | undefined; /** *The version of the flow module.
* @public */ Version?: number | undefined; /** *The name of the alias.
* @public */ Name?: string | undefined; /** *The description of the alias.
* @public */ Description?: string | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface DescribeContactFlowModuleAliasResponse { /** *Information about the flow module alias.
* @public */ ContactFlowModuleAlias?: ContactFlowModuleAliasInfo | undefined; } /** * @public */ export interface DescribeDataTableRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no * alias is provided, the default behavior is identical to providing the $LATEST alias.
* @public */ DataTableId: string | undefined; } /** *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.
* @public */ export interface DataTable { /** *The human-readable name of the data table. Must be unique within the instance and conform to Connect naming * standards.
* @public */ Name: string | undefined; /** *The unique identifier for the data table. Does not include version aliases.
* @public */ Id: string | undefined; /** *The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
* @public */ Arn: string | undefined; /** *The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are * specified.
* @public */ TimeZone: string | undefined; /** *An optional description of the data table's purpose and contents.
* @public */ Description?: string | undefined; /** *The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, * and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values * simultaneously.
* @public */ ValueLockLevel?: DataTableLockLevel | undefined; /** *The lock version information used for optimistic locking and table versioning. Changes with each update to * prevent concurrent modification conflicts.
* @public */ LockVersion?: DataTableLockVersion | undefined; /** *A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
* @public */ Version?: string | undefined; /** *A description of the customer managed version.
* @public */ VersionDescription?: string | undefined; /** *The current status of the data table. One of PUBLISHED or SAVED.
* @public */ Status?: DataTableStatus | undefined; /** *The timestamp when the data table was created.
* @public */ CreatedTime?: Date | undefined; /** *The timestamp when the data table or any of its properties were last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The Amazon Web Services Region where the data table was last modified, used for region replication.
* @public */ LastModifiedRegion?: string | undefined; /** *Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
* @public */ Tags?: RecordThe complete data table information including metadata, configuration, and versioning details.
* @public */ DataTable: DataTable | undefined; } /** * @public */ export interface DescribeDataTableAttributeRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
* @public */ DataTableId: string | undefined; /** *The name of the attribute to retrieve detailed information for.
* @public */ AttributeName: string | undefined; } /** *Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values * that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a * primary key for record identification.
* @public */ export interface DataTableAttribute { /** *The unique identifier for the attribute within the data table.
* @public */ AttributeId?: string | undefined; /** *The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming * standards.
* @public */ Name: string | undefined; /** *The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. * Determines how values are validated and processed.
* @public */ ValueType: DataTableAttributeValueType | undefined; /** *An optional description explaining the purpose and usage of this attribute.
* @public */ Description?: string | undefined; /** *The unique identifier of the data table that contains this attribute.
* @public */ DataTableId?: string | undefined; /** *The Amazon Resource Name (ARN) of the data table that contains this attribute.
* @public */ DataTableArn?: string | undefined; /** *Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes * must have unique value combinations and cannot contain expressions.
* @public */ Primary?: boolean | undefined; /** *The version identifier for this attribute, used for versioning and change tracking.
* @public */ Version?: string | undefined; /** *The lock version for this attribute, used for optimistic locking to prevent concurrent modification * conflicts.
* @public */ LockVersion?: DataTableLockVersion | undefined; /** *The timestamp when this attribute was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this attribute was last modified, used for region replication.
* @public */ LastModifiedRegion?: string | undefined; /** *The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional * Connect-specific validations for data integrity.
* @public */ Validation?: Validation | undefined; } /** * @public */ export interface DescribeDataTableAttributeResponse { /** *The complete attribute information including configuration, validation rules, lock version, and metadata.
* @public */ Attribute: DataTableAttribute | undefined; } /** * @public */ export interface DescribeEmailAddressRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the email address.
* @public */ EmailAddressId: string | undefined; } /** * @public */ export interface DescribeEmailAddressResponse { /** *The identifier of the email address.
* @public */ EmailAddressId?: string | undefined; /** *The Amazon Resource Name (ARN) of the email address.
* @public */ EmailAddressArn?: string | undefined; /** *The email address, including the domain.
* @public */ EmailAddress?: string | undefined; /** *The display name of email address
* @public */ DisplayName?: string | undefined; /** *The description of the email address.
* @public */ Description?: string | undefined; /** *The email address creation timestamp in ISO 8601 Datetime.
* @public */ CreateTimestamp?: string | undefined; /** *The email address last modification timestamp in ISO 8601 Datetime.
* @public */ ModifiedTimestamp?: string | undefined; /** *A list of alias configurations associated with this email address. Contains details about email addresses that * forward to this primary email address. The list can contain at most one alias configuration per email address.
* @public */ AliasConfigurations?: AliasConfiguration[] | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the contact evaluation.
* @public */ EvaluationFormId: string | undefined; /** *A version of the evaluation form.
* @public */ EvaluationFormVersion?: number | undefined; } /** * @public */ export interface DescribeHoursOfOperationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; } /** *Identifier for a hours of operations resource: ARN, ID, Name
* @public */ export interface HoursOfOperationsIdentifier { /** *Name of the hours of operation
* @public */ Name: string | undefined; /** *Unique identifier of the hours of operation.
* @public */ Id: string | undefined; /** *Amazon Resource Name (ARN) of the hours of operations.
* @public */ Arn?: string | undefined; } /** *Information about of the hours of operation.
* @public */ export interface HoursOfOperation { /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId?: string | undefined; /** *The Amazon Resource Name (ARN) for the hours of operation.
* @public */ HoursOfOperationArn?: string | undefined; /** *The name for the hours of operation.
* @public */ Name?: string | undefined; /** *The description for the hours of operation.
* @public */ Description?: string | undefined; /** *The time zone for the hours of operation.
* @public */ TimeZone?: string | undefined; /** *Configuration information for the hours of operation.
* @public */ Config?: HoursOfOperationConfig[] | undefined; /** *Information about parent hours of operations.
* @public */ ParentHoursOfOperations?: HoursOfOperationsIdentifier[] | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeHoursOfOperationResponse { /** *The hours of operation.
* @public */ HoursOfOperation?: HoursOfOperation | undefined; } /** * @public */ export interface DescribeHoursOfOperationOverrideRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The identifier for the hours of operation override.
* @public */ HoursOfOperationOverrideId: string | undefined; } /** *Information about the hours of operations override.
* @public */ export interface HoursOfOperationOverride { /** *The identifier for the hours of operation override.
* @public */ HoursOfOperationOverrideId?: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId?: string | undefined; /** *The Amazon Resource Name (ARN) for the hours of operation.
* @public */ HoursOfOperationArn?: string | undefined; /** *The name of the hours of operation override.
* @public */ Name?: string | undefined; /** *The description of the hours of operation override.
* @public */ Description?: string | undefined; /** *Configuration information for the hours of operation override: day, start time, and end time.
* @public */ Config?: HoursOfOperationOverrideConfig[] | undefined; /** *The date from which the hours of operation override would be effective.
* @public */ EffectiveFrom?: string | undefined; /** *The date until the hours of operation override is effective.
* @public */ EffectiveTill?: string | undefined; /** *Configuration for a recurring event.
* @public */ RecurrenceConfig?: RecurrenceConfig | undefined; /** *Whether the override will be defined as a standard or as a recurring event.
* @public */ OverrideType?: OverrideType | undefined; } /** * @public */ export interface DescribeHoursOfOperationOverrideResponse { /** *Information about the hours of operations override.
* @public */ HoursOfOperationOverride?: HoursOfOperationOverride | undefined; } /** * @public */ export interface DescribeInstanceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Relevant * details why the instance was not successfully created.
* @public */ export interface InstanceStatusReason { /** *The message.
* @public */ Message?: string | undefined; } /** *The Amazon Connect instance.
* @public */ export interface Instance { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the instance.
* @public */ Arn?: string | undefined; /** *The identity management type.
* @public */ IdentityManagementType?: DirectoryType | undefined; /** *The alias of instance.
* @public */ InstanceAlias?: string | undefined; /** *When the instance was created.
* @public */ CreatedTime?: Date | undefined; /** *The service role of the instance.
* @public */ ServiceRole?: string | undefined; /** *The state of the instance.
* @public */ InstanceStatus?: InstanceStatus | undefined; /** *Relevant * details why the instance was not successfully created.
* @public */ StatusReason?: InstanceStatusReason | undefined; /** *Whether inbound calls are enabled.
* @public */ InboundCallsEnabled?: boolean | undefined; /** *Whether outbound calls are enabled.
* @public */ OutboundCallsEnabled?: boolean | undefined; /** *This URL allows contact center users to access the Amazon Connect admin website.
* @public */ InstanceAccessUrl?: string | undefined; /** *The tags of an instance.
* @public */ Tags?: RecordStatus 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.
* @public */ export interface ReplicationStatusSummary { /** *The Amazon Web Services Region. This can be either the source or the replica Region, depending where it appears * in the summary list.
* @public */ Region?: string | undefined; /** *The state of the replication.
* @public */ ReplicationStatus?: InstanceReplicationStatus | undefined; /** *A description of the replication status. Use this information to resolve any issues that are preventing the * successful replication of your Amazon Connect instance to another Region.
* @public */ ReplicationStatusReason?: string | undefined; } /** *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.
* @public */ export interface ReplicationConfiguration { /** *A list of replication status summaries. The summaries contain details about the replication of configuration * information for Amazon Connect resources, for each Amazon Web Services Region.
* @public */ ReplicationStatusSummaryList?: ReplicationStatusSummary[] | undefined; /** *The Amazon Web Services Region where the source Amazon Connect instance was created. This is the Region where * the ReplicateInstance API was called to start the replication process.
* @public */ SourceRegion?: string | undefined; /** *The URL that is used to sign-in to your Amazon Connect instance according to your traffic distribution group * configuration. For more information about sign-in and traffic distribution groups, see Important things to know in the * Create traffic distribution groups topic in the Amazon Connect Administrator * Guide.
* @public */ GlobalSignInEndpoint?: string | undefined; } /** * @public */ export interface DescribeInstanceResponse { /** *The name of the instance.
* @public */ Instance?: Instance | undefined; /** *Status information about the replication process. This field is included only when you are using the ReplicateInstance API to * replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
* @public */ ReplicationConfiguration?: ReplicationConfiguration | undefined; } /** * @public */ export interface DescribeInstanceAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The type of attribute.
* @public */ AttributeType: InstanceAttributeType | undefined; } /** *A toggle for an individual feature at the instance level.
* @public */ export interface Attribute { /** *The type of attribute.
* @public */ AttributeType?: InstanceAttributeType | undefined; /** *The value of the attribute.
* @public */ Value?: string | undefined; } /** * @public */ export interface DescribeInstanceAttributeResponse { /** *The * type * of attribute.
* @public */ Attribute?: Attribute | undefined; } /** * @public */ export interface DescribeInstanceStorageConfigRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ AssociationId: string | undefined; /** *A valid resource type.
* @public */ ResourceType: InstanceStorageResourceType | undefined; } /** * @public */ export interface DescribeInstanceStorageConfigResponse { /** *A valid storage type.
* @public */ StorageConfig?: InstanceStorageConfig | undefined; } /** * @public */ export interface DescribeNotificationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the notification.
* @public */ NotificationId: string | undefined; } /** *Contains information about a notification, including its content, priority, recipients, and metadata.
* @public */ export interface Notification { /** *The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.
* @public */ Content?: PartialThe unique identifier for the notification.
* @public */ Id: string | undefined; /** *The Amazon Resource Name (ARN) of the notification.
* @public */ Arn: string | undefined; /** *The priority level of the notification. Valid values are URGENT, HIGH, and LOW.
* @public */ Priority?: NotificationPriority | undefined; /** *A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.
* @public */ Recipients?: string[] | undefined; /** *The timestamp when the notification was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The timestamp when the notification was created.
* @public */ CreatedAt?: Date | undefined; /** *The timestamp when the notification expires and is no longer displayed to users.
* @public */ ExpiresAt?: Date | undefined; /** *The AWS Region where the notification was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
The complete notification information including content, priority, recipients, and metadata.
* @public */ Notification: Notification | undefined; } /** * @public */ export interface DescribePhoneNumberRequest { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId: string | undefined; } /** *The status of the phone number.
*
* CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber
* operation succeeded.
* IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at
* a later time to verify if the previous operation has completed.
* FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber
* operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be
* that the TargetArn value you are claiming or updating a phone number to has reached its limit of total
* claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you
* have one day to retry claiming the phone number before the number is released back to the inventory for other
* customers to claim.
The status.
* @public */ Status?: PhoneNumberWorkflowStatus | undefined; /** *The status message.
* @public */ Message?: string | undefined; } /** *Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.
* @public */ export interface ClaimedPhoneNumberSummary { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId?: string | undefined; /** *The Amazon Resource Name (ARN) of the phone number.
* @public */ PhoneNumberArn?: string | undefined; /** *The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
The ISO country code.
* @public */ PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined; /** *The type of phone number.
* @public */ PhoneNumberType?: PhoneNumberType | undefined; /** *The description of the phone number.
* @public */ PhoneNumberDescription?: string | undefined; /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.
* @public */ TargetArn?: string | undefined; /** *The identifier of the Amazon Connect instance that phone numbers are claimed to. You * can find the * instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe status of the phone number.
*
* CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber
* operation succeeded.
* IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at
* a later time to verify if the previous operation has completed.
* FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber
* operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be
* that the TargetArn value you are claiming or updating a phone number to has reached its limit of total
* claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you
* have one day to retry claiming the phone number before the number is released back to the inventory for other
* customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming fails.
*The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services * End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number * that was imported from Amazon Web Services End User Messaging.
* @public */ SourcePhoneNumberArn?: string | undefined; } /** * @public */ export interface DescribePhoneNumberResponse { /** *Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
* @public */ ClaimedPhoneNumberSummary?: ClaimedPhoneNumberSummary | undefined; } /** * @public */ export interface DescribePredefinedAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance.
* @public */ InstanceId: string | undefined; /** *The name of the predefined attribute.
* @public */ Name: string | undefined; } /** *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.
* @public */ export interface PredefinedAttributeConfiguration { /** *When this parameter is set to true, Amazon Connect enforces strict validation on the specific values, if the * values are predefined in attributes. The contact will store only valid and predefined values for teh predefined * attribute key.
* @public */ EnableValueValidationOnAssociation?: boolean | undefined; /** *A boolean flag used to indicate whether a predefined attribute should be displayed in the Amazon Connect admin website.
* @public */ IsReadOnly?: boolean | undefined; } /** *Information about a predefined attribute.
* @public */ export interface PredefinedAttribute { /** *The name of the predefined attribute.
* @public */ Name?: string | undefined; /** *The values of the predefined attribute.
* @public */ Values?: PredefinedAttributeValues | undefined; /** *Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
* @public */ Purposes?: string[] | undefined; /** *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.
* @public */ AttributeConfiguration?: PredefinedAttributeConfiguration | undefined; /** *Last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *Last modified region.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribePredefinedAttributeResponse { /** *Information about the predefined attribute.
* @public */ PredefinedAttribute?: PredefinedAttribute | undefined; } /** * @public */ export interface DescribePromptRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the prompt.
* @public */ PromptId: string | undefined; } /** *Information about a prompt.
* @public */ export interface Prompt { /** *The Amazon Resource Name (ARN) of the prompt.
* @public */ PromptARN?: string | undefined; /** *A unique identifier for the prompt.
* @public */ PromptId?: string | undefined; /** *The name of the prompt.
* @public */ Name?: string | undefined; /** *The description of the prompt.
* @public */ Description?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribePromptResponse { /** *Information about the prompt.
* @public */ Prompt?: Prompt | undefined; } /** * @public */ export interface DescribeQueueRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the queue.
* @public */ QueueId: string | undefined; } /** *Contains information about a queue.
* @public */ export interface Queue { /** *The name of the queue.
* @public */ Name?: string | undefined; /** *The Amazon Resource Name (ARN) for the queue.
* @public */ QueueArn?: string | undefined; /** *The identifier for the queue.
* @public */ QueueId?: string | undefined; /** *The description of the queue.
* @public */ Description?: string | undefined; /** *The outbound caller ID name, number, and outbound whisper flow.
* @public */ OutboundCallerConfig?: OutboundCallerConfig | undefined; /** *The outbound email address ID for a specified queue.
* @public */ OutboundEmailConfig?: OutboundEmailConfig | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId?: string | undefined; /** *The maximum number of contacts that can be in the queue before it is considered full.
* @public */ MaxContacts?: number | undefined; /** *The status of the queue.
* @public */ Status?: QueueStatus | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeQueueResponse { /** *The name of the queue.
* @public */ Queue?: Queue | undefined; } /** * @public */ export interface DescribeQuickConnectRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the quick connect.
* @public */ QuickConnectId: string | undefined; } /** *Contains information about a quick connect.
* @public */ export interface QuickConnect { /** *The Amazon Resource Name (ARN) of the quick connect.
* @public */ QuickConnectARN?: string | undefined; /** *The identifier for the quick connect.
* @public */ QuickConnectId?: string | undefined; /** *The name of the quick connect.
* @public */ Name?: string | undefined; /** *The description.
* @public */ Description?: string | undefined; /** *Contains information about the quick connect.
* @public */ QuickConnectConfig?: QuickConnectConfig | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeQuickConnectResponse { /** *Information about the quick connect.
* @public */ QuickConnect?: QuickConnect | undefined; } /** * @public */ export interface DescribeRoutingProfileRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the routing profile.
* @public */ RoutingProfileId: string | undefined; } /** *Contains information about a routing profile.
* @public */ export interface RoutingProfile { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId?: string | undefined; /** *The name of the routing profile.
* @public */ Name?: string | undefined; /** *The Amazon Resource Name (ARN) of the routing profile.
* @public */ RoutingProfileArn?: string | undefined; /** *The identifier of the routing profile.
* @public */ RoutingProfileId?: string | undefined; /** *The description of the routing profile.
* @public */ Description?: string | undefined; /** *The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
* @public */ MediaConcurrencies?: MediaConcurrency[] | undefined; /** *The identifier of the default outbound queue for this routing profile.
* @public */ DefaultOutboundQueueId?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe number of associated queues in routing profile.
* @public */ NumberOfAssociatedQueues?: number | undefined; /** *The number of associated manual assignment queues in routing profile.
* @public */ NumberOfAssociatedManualAssignmentQueues?: number | undefined; /** *The number of associated users in routing profile.
* @public */ NumberOfAssociatedUsers?: number | undefined; /** *Whether agents with this routing profile will have their routing order calculated based on time since * their last inbound contact or longest idle time.
* @public */ AgentAvailabilityTimer?: AgentAvailabilityTimer | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *Whether this a default routing profile.
* @public */ IsDefault?: boolean | undefined; /** *The IDs of the associated queue.
* @public */ AssociatedQueueIds?: string[] | undefined; /** *The IDs of the associated manual assignment queues.
* @public */ AssociatedManualAssignmentQueueIds?: string[] | undefined; } /** * @public */ export interface DescribeRoutingProfileResponse { /** *The routing profile.
* @public */ RoutingProfile?: RoutingProfile | undefined; } /** * @public */ export interface DescribeRuleRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the rule.
* @public */ RuleId: string | undefined; } /** *Information about a rule.
* @public */ export interface Rule { /** *The name of the rule.
* @public */ Name: string | undefined; /** *A unique identifier for the rule.
* @public */ RuleId: string | undefined; /** *The Amazon Resource Name (ARN) of the rule.
* @public */ RuleArn: string | undefined; /** *The event source to trigger the rule.
* @public */ TriggerEventSource: RuleTriggerEventSource | undefined; /** *The conditions of the rule.
* @public */ Function: string | undefined; /** *A list of actions to be run when the rule is triggered.
* @public */ Actions: RuleAction[] | undefined; /** *The publish status of the rule.
* @public */ PublishStatus: RulePublishStatus | undefined; /** *The timestamp for when the rule was created.
* @public */ CreatedTime: Date | undefined; /** *The timestamp for the when the rule was last updated.
* @public */ LastUpdatedTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who last updated the rule.
* @public */ LastUpdatedBy: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordInformation about the rule.
* @public */ Rule: Rule | undefined; } /** * @public */ export interface DescribeSecurityProfileRequest { /** *The identifier for the security profle.
* @public */ SecurityProfileId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains information about a security profile.
* @public */ export interface SecurityProfile { /** *The identifier for the security profile.
* @public */ Id?: string | undefined; /** *The organization resource identifier for the security profile.
* @public */ OrganizationResourceId?: string | undefined; /** *The Amazon Resource Name (ARN) for the security profile.
* @public */ Arn?: string | undefined; /** *The name for the security profile.
* @public */ SecurityProfileName?: string | undefined; /** *The description of the security profile.
* @public */ Description?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe list of tags that a security profile uses to restrict access to resources in Amazon Connect.
* @public */ AllowedAccessControlTags?: RecordThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
* @public */ TagRestrictedResources?: string[] | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following
* are acceptable ResourceNames: User.
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
* @public */ AllowedAccessControlHierarchyGroupId?: string | undefined; /** *The granular access control configuration for the security profile, including data table permissions.
* @public */ GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined; } /** * @public */ export interface DescribeSecurityProfileResponse { /** *The security profile.
* @public */ SecurityProfile?: SecurityProfile | undefined; } /** * @public */ export interface DescribeTestCaseRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case.
* @public */ TestCaseId: string | undefined; /** *The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.
* @public */ Status?: TestCaseStatus | undefined; } /** *Contains information about a test case.
* @public */ export interface TestCase { /** *The Amazon Resource Name (ARN) of the test case.
* @public */ Arn?: string | undefined; /** *The identifier of the test case.
* @public */ Id?: string | undefined; /** *The name of the test case.
* @public */ Name?: string | undefined; /** *The JSON string that represents the content of the test.
* @public */ Content?: string | undefined; /** *Defines the starting point for the test, including channel type and parameters.
* @public */ EntryPoint?: TestCaseEntryPoint | undefined; /** *Defines the test attributes for precise data representation. The value must be a valid JSON string.
* @public */ InitializationData?: string | undefined; /** *The description of the test case.
* @public */ Description?: string | undefined; /** *Indicates the test status as either SAVED or PUBLISHED.
* @public */ Status?: TestCaseStatus | undefined; /** *The time at which the test case was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The region in which the test case was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The tags used to organize, track, or control access for this resource.
* @public */ Tags?: RecordThe SHA256 hash of the test case content.
* @public */ TestCaseSha256?: string | undefined; } /** * @public */ export interface DescribeTestCaseResponse { /** *The test case object containing all test case information.
* @public */ TestCase?: TestCase | undefined; } /** * @public */ export interface DescribeTrafficDistributionGroupRequest { /** *The identifier of the traffic distribution group. * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. * The ARN must be provided if the call is from the replicated Region.
* @public */ TrafficDistributionGroupId: string | undefined; } /** *Information about a traffic distribution group.
* @public */ export interface TrafficDistributionGroup { /** *The identifier of the traffic distribution group. * This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. * The ARN must be provided if the call is from the replicated Region.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the traffic distribution group.
* @public */ Arn?: string | undefined; /** *The name of the traffic distribution group.
* @public */ Name?: string | undefined; /** *The description of the traffic distribution group.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN).
* @public */ InstanceArn?: string | undefined; /** *The status of the traffic distribution group.
*
* CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup
* operation is still in progress and has not yet completed.
* ACTIVE means the previous CreateTrafficDistributionGroup
* operation has succeeded.
* CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup
* operation has failed.
* PENDING_DELETION means the previous DeleteTrafficDistributionGroup
* operation is still in progress and has not yet completed.
* DELETION_FAILED means the previous DeleteTrafficDistributionGroup
* operation has failed.
* UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution operation
* is still in progress and has not yet completed.
The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordWhether this is the default traffic distribution group created during instance
* replication. The default traffic distribution group cannot be deleted by the
* DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as
* part of the process for deleting a replica.
The SignInConfig distribution is available only on a
* default TrafficDistributionGroup (see the IsDefault parameter in the
* TrafficDistributionGroup
* data type). If you call
* UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
* an InvalidRequestException is returned.
Information about the traffic distribution group.
* @public */ TrafficDistributionGroup?: TrafficDistributionGroup | undefined; } /** * @public */ export interface DescribeUserRequest { /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains information about a user account for an Amazon Connect instance.
* @public */ export interface User { /** *The identifier of the user account.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the user account.
* @public */ Arn?: string | undefined; /** *The user name assigned to the user account.
* @public */ Username?: string | undefined; /** *Information about the user identity.
* @public */ IdentityInfo?: UserIdentityInfo | undefined; /** *Information about the phone configuration for the user.
* @public */ PhoneConfig?: UserPhoneConfig | undefined; /** *The identifier of the user account in the directory used for identity management.
* @public */ DirectoryUserId?: string | undefined; /** *The identifiers of the security profiles for the user.
* @public */ SecurityProfileIds?: string[] | undefined; /** *The identifier of the routing profile for the user.
* @public */ RoutingProfileId?: string | undefined; /** *The identifier of the hierarchy group for the user.
* @public */ HierarchyGroupId?: string | undefined; /** *The * tags.
* @public */ Tags?: RecordThe list of auto-accept configuration settings for each channel.
* @public */ AutoAcceptConfigs?: AutoAcceptConfig[] | undefined; /** *The list of after contact work (ACW) timeout configuration settings for each channel.
* @public */ AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined; /** *The list of phone number configuration settings for each channel.
* @public */ PhoneNumberConfigs?: PhoneNumberConfig[] | undefined; /** *The list of persistent connection configuration settings for each channel.
* @public */ PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined; /** *The list of voice enhancement configuration settings for each channel.
* @public */ VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeUserResponse { /** *Information about the user account and configuration settings.
* @public */ User?: User | undefined; } /** * @public */ export interface DescribeUserHierarchyGroupRequest { /** *The identifier of the hierarchy group.
* @public */ HierarchyGroupId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains summary information about a hierarchy group.
* @public */ export interface HierarchyGroupSummary { /** *The identifier of the hierarchy group.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the hierarchy group.
* @public */ Arn?: string | undefined; /** *The name of the hierarchy group.
* @public */ Name?: string | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** *Contains information about the levels of a hierarchy group.
* @public */ export interface HierarchyPath { /** *Information about level one.
* @public */ LevelOne?: HierarchyGroupSummary | undefined; /** *Information about level two.
* @public */ LevelTwo?: HierarchyGroupSummary | undefined; /** *Information about level three.
* @public */ LevelThree?: HierarchyGroupSummary | undefined; /** *Information about level four.
* @public */ LevelFour?: HierarchyGroupSummary | undefined; /** *Information about level five.
* @public */ LevelFive?: HierarchyGroupSummary | undefined; } /** *Contains information about a hierarchy group.
* @public */ export interface HierarchyGroup { /** *The identifier of the hierarchy group.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the hierarchy group.
* @public */ Arn?: string | undefined; /** *The name of the hierarchy group.
* @public */ Name?: string | undefined; /** *The identifier of the level in the hierarchy group.
* @public */ LevelId?: string | undefined; /** *Information about the levels in the hierarchy group.
* @public */ HierarchyPath?: HierarchyPath | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface DescribeUserHierarchyGroupResponse { /** *Information about the hierarchy group.
* @public */ HierarchyGroup?: HierarchyGroup | undefined; } /** * @public */ export interface DescribeUserHierarchyStructureRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains information about a hierarchy level.
* @public */ export interface HierarchyLevel { /** *The identifier of the hierarchy level.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the hierarchy level.
* @public */ Arn?: string | undefined; /** *The name of the hierarchy level.
* @public */ Name?: string | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region where this resource was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** *Contains information about a hierarchy structure.
* @public */ export interface HierarchyStructure { /** *Information about level one.
* @public */ LevelOne?: HierarchyLevel | undefined; /** *Information about level two.
* @public */ LevelTwo?: HierarchyLevel | undefined; /** *Information about level three.
* @public */ LevelThree?: HierarchyLevel | undefined; /** *Information about level four.
* @public */ LevelFour?: HierarchyLevel | undefined; /** *Information about level five.
* @public */ LevelFive?: HierarchyLevel | undefined; } /** * @public */ export interface DescribeUserHierarchyStructureResponse { /** *Information about the hierarchy structure.
* @public */ HierarchyStructure?: HierarchyStructure | undefined; } /** * @public */ export interface DescribeViewRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the * instance.
* @public */ InstanceId: string | undefined; /** *The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
* @public */ ViewId: string | undefined; } /** * @public */ export interface DescribeViewResponse { /** *All view data is contained within the View object.
* @public */ View?: View | undefined; } /** * @public */ export interface DescribeVocabularyRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the custom vocabulary.
* @public */ VocabularyId: string | undefined; } /** *Contains information about a custom vocabulary.
* @public */ export interface Vocabulary { /** *A unique name of the custom vocabulary.
* @public */ Name: string | undefined; /** *The identifier of the custom vocabulary.
* @public */ Id: string | undefined; /** *The Amazon Resource Name (ARN) of the custom vocabulary.
* @public */ Arn: string | undefined; /** *The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see * What is Amazon Transcribe? *
* @public */ LanguageCode: VocabularyLanguageCode | undefined; /** *The current state of the custom vocabulary.
* @public */ State: VocabularyState | undefined; /** *The timestamp when the custom vocabulary was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The reason why the custom vocabulary was not created.
* @public */ FailureReason?: string | undefined; /** *The content of the custom vocabulary in plain-text format with a table of values. Each row
* in the table represents a word or a phrase, described with Phrase, IPA,
* SoundsLike, and DisplayAs fields. Separate the fields with TAB
* characters. For more information, see Create a custom
* vocabulary using a table.
The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordA list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally * domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
* @public */ Vocabulary: Vocabulary | undefined; } /** * @public */ export interface DescribeWorkspaceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; } /** *Contains information about a workspace, which defines the user experience by mapping views to pages.
* @public */ export interface Workspace { /** *Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED
* (only assigned users and routing profiles), and NONE (not visible).
The unique identifier of the workspace.
* @public */ Id: string | undefined; /** *The name of the workspace.
* @public */ Name: string | undefined; /** *The Amazon Resource Name (ARN) of the workspace.
* @public */ Arn: string | undefined; /** *The description of the workspace.
* @public */ Description?: string | undefined; /** *The theme configuration for the workspace, including colors and styling.
* @public */ Theme?: WorkspaceTheme | undefined; /** *The title displayed for the workspace.
* @public */ Title?: string | undefined; /** *The timestamp when the workspace was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The Amazon Web Services Region where the workspace was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The tags used to organize, track, or control access for the workspace.
* @public */ Tags?: RecordInformation about the workspace.
* @public */ Workspace: Workspace | undefined; } /** * @public */ export interface DisassociateAnalyticsDataSetRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the dataset to remove.
* @public */ DataSetId: string | undefined; /** *The identifier of the target account. Use to associate a dataset to a different account than the one containing * the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.
* @public */ TargetAccountId?: string | undefined; } /** * @public */ export interface DisassociateApprovedOriginRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The domain URL of the integrated application.
* @public */ Origin: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateBotRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *Configuration information of an Amazon Lex bot.
* @public */ LexBot?: LexBot | undefined; /** *The Amazon Lex V2 bot to disassociate from the instance.
* @public */ LexV2Bot?: LexV2Bot | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateEmailAddressAliasRequest { /** *The identifier of the email address.
* @public */ EmailAddressId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *Configuration object that specifies which alias relationship to remove. The alias association must currently * exist between the primary email address and the specified alias email address.
* @public */ AliasConfiguration: AliasConfiguration | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateEmailAddressAliasResponse { } /** * @public */ export interface DisassociateFlowRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the resource.
*Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
*
Amazon Web Services End User Messaging Social phone number ARN when using
* WHATSAPP_MESSAGING_PHONE_NUMBER
*
A valid resource type.
* @public */ ResourceType: FlowAssociationResourceType | undefined; } /** * @public */ export interface DisassociateFlowResponse { } /** * @public */ export interface DisassociateHoursOfOperationsRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the child hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The Amazon Resource Names (ARNs) of the parent hours of operation resources to disassociate with the child hours of operation resource.
* @public */ ParentHoursOfOperationIds: string[] | undefined; } /** * @public */ export interface DisassociateInstanceStorageConfigRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ AssociationId: string | undefined; /** *A valid resource type.
* @public */ ResourceType: InstanceStorageResourceType | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateLambdaFunctionRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
* @public */ InstanceId: string | undefined; /** *The Amazon Resource Name (ARN) of the Lambda function being disassociated.
* @public */ FunctionArn: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateLexBotRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The name of the Amazon Lex bot. Maximum character limit of 50.
* @public */ BotName: string | undefined; /** *The Amazon Web Services Region in which the Amazon Lex bot has been created.
* @public */ LexRegion: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociatePhoneNumberContactFlowRequest { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface DisassociateQueueEmailAddressesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the queue.
* @public */ QueueId: string | undefined; /** *List of email address identifiers to disassociate from the queue. These are the unique identifiers of email addresses that should no longer be routed to this queue.
* @public */ EmailAddressesId: string[] | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateQueueQuickConnectsRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the queue.
* @public */ QueueId: string | undefined; /** *The quick connects to disassociate from the queue.
* @public */ QuickConnectIds: string[] | undefined; } /** * @public */ export interface DisassociateRoutingProfileQueuesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the routing profile.
* @public */ RoutingProfileId: string | undefined; /** *The queues to disassociate from this routing profile.
* @public */ QueueReferences?: RoutingProfileQueueReference[] | undefined; /** *The manual assignment queues to disassociate with this routing profile.
* @public */ ManualAssignmentQueueReferences?: RoutingProfileQueueReference[] | undefined; } /** * @public */ export interface DisassociateSecurityKeyRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ AssociationId: string | undefined; /** *A unique, case-sensitive identifier that you provide to ensure the idempotency of the * request. If not provided, the Amazon Web Services * SDK populates this field. For more information about idempotency, see * Making retries safe with idempotent APIs.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface DisassociateSecurityProfilesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) * of the instance.
* @public */ InstanceId: string | undefined; /** *List of Security Profile Object.
* @public */ SecurityProfiles: SecurityProfileItem[] | undefined; /** *Only supported type is AI_AGENT.
* @public */ EntityType: EntityType | undefined; /** *ARN of a Q in Connect AI Agent.
* @public */ EntityArn: string | undefined; } /** * @public */ export interface DisassociateTrafficDistributionGroupUserRequest { /** *The identifier of the traffic distribution group. * This can be the ID or the ARN of the traffic distribution group.
* @public */ TrafficDistributionGroupId: string | undefined; /** *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface DisassociateTrafficDistributionGroupUserResponse { } /** *Information about proficiency to be disassociated from the user.
* @public */ export interface UserProficiencyDisassociate { /** *The name of user's proficiency.
* @public */ AttributeName: string | undefined; /** *The value of user's proficiency.
* @public */ AttributeValue: string | undefined; } /** * @public */ export interface DisassociateUserProficienciesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The proficiencies to disassociate from the user.
* @public */ UserProficiencies: UserProficiencyDisassociate[] | undefined; } /** * @public */ export interface DisassociateWorkspaceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in * the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the workspace.
* @public */ WorkspaceId: string | undefined; /** *The Amazon Resource Names (ARNs) of the resources to disassociate from the workspace.
* @public */ ResourceArns: string[] | undefined; } /** * @public */ export interface DisassociateWorkspaceResponse { /** *A list of resources that were successfully disassociated from the workspace.
* @public */ SuccessfulList?: SuccessfulBatchAssociationSummary[] | undefined; /** *A list of resources that failed to be disassociated from the workspace, including error details.
* @public */ FailedList?: FailedBatchAssociationSummary[] | undefined; } /** * @public */ export interface DismissUserContactRequest { /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the contact.
* @public */ ContactId: string | undefined; } /** * @public */ export interface DismissUserContactResponse { } /** *A data table value evaluation set.
* @public */ export interface DataTableValueEvaluationSet { /** *The set's primary values.
* @public */ PrimaryValues?: PrimaryValue[] | undefined; /** *The set's attribute names.
* @public */ AttributeNames: string[] | undefined; } /** * @public */ export interface EvaluateDataTableValuesRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
* @public */ DataTableId: string | undefined; /** *A list of value evaluation sets specifying which primary values and attributes to evaluate.
* @public */ Values: DataTableValueEvaluationSet[] | undefined; /** *Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table * time zone if not provided.
* @public */ TimeZone?: string | undefined; /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of data table values to return in one page of results.
* @public */ MaxResults?: number | undefined; } /** *A data table evaluated value.
* @public */ export interface DataTableEvaluatedValue { /** *The value's record ID.
* @public */ RecordId: string | undefined; /** *The value's primary values.
* @public */ PrimaryValues: PrimaryValue[] | undefined; /** *The value's attribute name.
* @public */ AttributeName: string | undefined; /** *The value's value type.
* @public */ ValueType: DataTableAttributeValueType | undefined; /** *The value's found.
* @public */ Found: boolean | undefined; /** *The value's error.
* @public */ Error: boolean | undefined; /** *The value's evaluated value.
* @public */ EvaluatedValue: string | undefined; } /** * @public */ export interface EvaluateDataTableValuesResponse { /** *A list of evaluated values with their computed results, error information, and metadata.
* @public */ Values: DataTableEvaluatedValue[] | undefined; /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; } /** * Request to GetAttachedFile API. * @public */ export interface GetAttachedFileRequest { /** *The unique identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier of the attached file resource.
* @public */ FileId: string | undefined; /** *Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
* @public */ UrlExpiryInSeconds?: number | undefined; /** *The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
*This value must be a valid ARN.
*Metadata used to download the attached file.
* @public */ export interface DownloadUrlMetadata { /** *A pre-signed URL that should be used to download the attached file.
* @public */ Url?: string | undefined; /** *The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. * For example, 2019-11-08T02:41:28.172Z.
* @public */ UrlExpiry?: string | undefined; } /** * Response from GetAttachedFile API. * @public */ export interface GetAttachedFileResponse { /** *The unique identifier of the attached file resource (ARN).
* @public */ FileArn?: string | undefined; /** *The unique identifier of the attached file resource.
* @public */ FileId?: string | undefined; /** *The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
* yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The current status of the attached file.
* @public */ FileStatus?: FileStatusType | undefined; /** *A case-sensitive name of the attached file being uploaded.
* @public */ FileName?: string | undefined; /** *The size of the attached file in bytes.
* @public */ FileSizeInBytes: number | undefined; /** *The resource to which the attached file is (being) uploaded to. Cases are the only current supported * resource.
* @public */ AssociatedResourceArn?: string | undefined; /** *The use case for the file.
* @public */ FileUseCaseType?: FileUseCaseType | undefined; /** *Represents the identity that created the file.
* @public */ CreatedBy?: CreatedByInfo | undefined; /** *URL and expiry to be used when downloading the attached file.
* @public */ DownloadUrlMetadata?: DownloadUrlMetadata | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags":
* \{"key1":"value1", "key2":"value2"\} \}.
The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the initial contact.
* @public */ InitialContactId: string | undefined; } /** * @public */ export interface GetContactAttributesResponse { /** *Information about the attributes.
* @public */ Attributes?: RecordContains the details of a metric to be retrieved for a contact. Use this object to specify which * contact level metrics you want to include in your GetContactMetrics request.
* @public */ export interface ContactMetricInfo { /** *The name of the metric to retrieve. Supported values are POSITION_IN_QUEUE (returns the contact's * current position in the queue) and ESTIMATED_WAIT_TIME (returns the predicted wait time in seconds).
* @public */ Name: ContactMetricName | undefined; } /** * @public */ export interface GetContactMetricsRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: string | undefined; /** *A list of contact level metrics to retrieve.Supported metrics include POSITION_IN_QUEUE (the contact's * current position in the queue) and ESTIMATED_WAIT_TIME (the predicted time in seconds until the contact is * connected to an agent)
* @public */ Metrics: ContactMetricInfo[] | undefined; } /** *Contains the numeric value of a contact metric result.
* @public */ export type ContactMetricValue = ContactMetricValue.NumberMember | ContactMetricValue.$UnknownMember; /** * @public */ export declare namespace ContactMetricValue { /** *The numeric value of the metric result. For POSITION_IN_QUEUE, this represents the contact's * current position in the queue (e.g., 3.00 means third in line). For ESTIMATED_WAIT_TIME, this represents * the predicted wait time in seconds (e.g., 120.00 means approximately 2 minutes).
* @public */ interface NumberMember { Number: number; $unknown?: never; } /** * @public */ interface $UnknownMember { Number?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorContains the result of a requested metric for the contact. This object is returned as part of the * GetContactMetrics response and includes both the metric name and its calculated value.
* @public */ export interface ContactMetricResult { /** *The name of the metric that was retrieved. This corresponds to the metric name specified in the * request, such as POSITION_IN_QUEUE or ESTIMATED_WAIT_TIME.
* @public */ Name: ContactMetricName | undefined; /** *The calculated value for the requested metric. This object contains the numeric result based on * the contact's current state in the queue.
* @public */ Value: ContactMetricValue | undefined; } /** * @public */ export interface GetContactMetricsResponse { /** *A list of metric results containing the calculated values for each requested metric. Each result includes * the metric name and its corresponding value. For example, POSITION_IN_QUEUE returns a numeric value representing * the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.
* @public */ MetricResults?: ContactMetricResult[] | undefined; /** *The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided * in the request.
* @public */ Id?: string | undefined; /** *The ARN of the contact for which metrics were retrieved.
* @public */ Arn?: string | undefined; } /** *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.
*The name of the metric.
* @public */ Name?: CurrentMetricName | undefined; /** *Out of the box current metrics or custom metrics can be referenced via this field. This field is a valid AWS Connect Arn or a UUID.
* @public */ MetricId?: string | undefined; /** *The Unit parameter is not supported for custom metrics.
*The unit for the metric.
* @public */ Unit?: Unit | undefined; } /** *Contains the filter to apply when retrieving metrics.
* @public */ export interface Filters { /** *The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues
* per request. The GetCurrentMetricsData API in particular requires a queue when you include a
* Filter in your request.
The channel to use to filter the metrics.
* @public */ Channels?: Channel[] | undefined; /** *A list of up to 100 routing profile IDs or ARNs.
* @public */ RoutingProfiles?: string[] | undefined; /** *A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
* @public */ RoutingStepExpressions?: string[] | undefined; /** *A list of up to 50 agent status IDs or ARNs.
* @public */ AgentStatuses?: string[] | undefined; /** *A list of up to 10 subtypes can be provided.
* @public */ Subtypes?: string[] | undefined; /** *A list of up to 10 validationTestTypes can be provided.
* @public */ ValidationTestTypes?: string[] | undefined; } /** *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.
The current metric names.
* @public */ SortByMetric?: CurrentMetricName | undefined; /** *The way to sort.
* @public */ SortOrder?: SortOrder | undefined; } /** * @public */ export interface GetCurrentMetricDataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The filters to apply to returned metrics. You can filter up to the following limits:
*Queues: 100
*Routing profiles: 100
*Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
*RoutingStepExpressions: 50
*AgentStatuses: 50
*Subtypes: 10
*ValidationTestTypes: 10
*Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any * channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource * IDs and resource ARNs in the same request.
*When using AgentStatuses as filter make sure Queues is added as primary filter.
When using Subtypes as filter make sure Queues is added as primary filter.
When using ValidationTestTypes as filter make sure Queues is added as primary filter.
When using the RoutingStepExpression filter, you need to pass exactly one QueueId. The
* filter is also case sensitive so when using the RoutingStepExpression filter, grouping by
* ROUTING_STEP_EXPRESSION is required.
Currently tagging is only supported on the resources that are passed in the filter.
* @public */ Filters: Filters | undefined; /** *Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets
* based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped
* by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues.
The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no * grouping is included in the request, the aggregation happens at the instance-level.
*If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
If you group by AGENT_STATUS, you must include the QUEUE as the primary grouping and
* use queue filter. When you group by AGENT_STATUS, the only metric available is the
* AGENTS_ONLINE metric.
If you group by SUBTYPE or VALIDATION_TEST_TYPE as secondary grouping then you must include QUEUE as
* primary grouping and use Queue as filter
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
* addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
* CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
When using the RoutingStepExpression filter, group by ROUTING_STEP_EXPRESSION is
* required.
The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a * description of all the metrics, see Metrics definitions in the Amazon Connect Administrator Guide.
*MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.
*Unit: COUNT
*Name in real-time metrics report: ACW *
*Unit: COUNT
*Name in real-time metrics report: Available *
*Unit: COUNT
*Name in real-time metrics report: Error *
*Unit: COUNT
*Name in real-time metrics report: NPT (Non-Productive * Time) *
*Unit: COUNT
*Name in real-time metrics report: On contact *
*Unit: COUNT
*Name in real-time metrics report: On contact *
*Unit: COUNT
*Name in real-time metrics report: Online *
*Unit: COUNT
*Name in real-time metrics report: Staffed *
*Unit: COUNT
*Name in real-time metrics report: In queue *
*Unit: COUNT
*Name in real-time metrics report: Scheduled *
*Unit: SECONDS
*This metric supports filter and grouping combination only used for core routing purpose. * Valid filter and grouping use cases: *
*Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]
*Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING_STEP_EXPRESSION”].
*Unit: SECONDS
*When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
*When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if * you get a response like this:
*
* \{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0 \}
The actual OLDEST_CONTACT_AGE is 24 seconds.
*When the filter RoutingStepExpression is used, this metric is still calculated from enqueue
* time. For example, if a contact that has been queued under OLDEST_CONTACT_AGE for this queue
* will be counted starting from 10, not 0.
Name in real-time metrics report: Oldest *
*Unit: COUNT
*Name in real-time metrics report: Active *
*Unit: COUNT
*Name in real-time metrics report: Availability *
*The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.
*The token expires after 5 minutes from the time it is created. Subsequent requests that use * the token must use the same request parameters as the request that generated the token.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | undefined; /** *The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources
* are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is sorted based on the
* input metrics.
Note the following:
*Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
Contains the data for a real-time metric.
* @public */ export interface CurrentMetricData { /** *Information about the metric.
* @public */ Metric?: CurrentMetric | undefined; /** *The value of the metric.
* @public */ Value?: number | undefined; } /** *Information about the routing profile assigned to the user.
* @public */ export interface RoutingProfileReference { /** *The identifier of the routing profile.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the routing profile.
* @public */ Arn?: string | undefined; } /** *Contains information about the dimensions for a set of metrics.
* @public */ export interface Dimensions { /** *Information about the queue for which metrics are returned.
* @public */ Queue?: QueueReference | undefined; /** *The channel used for grouping and filters.
* @public */ Channel?: Channel | undefined; /** *Information about the routing profile assigned to the user.
* @public */ RoutingProfile?: RoutingProfileReference | undefined; /** *The expression of a step in a routing criteria.
* @public */ RoutingStepExpression?: string | undefined; /** *Information about the agent status assigned to the user.
* @public */ AgentStatus?: AgentStatusIdentifier | undefined; /** *The subtype of the channel used for the contact.
* @public */ Subtype?: string | undefined; /** *The testing and simulation type
* @public */ ValidationTestType?: string | undefined; } /** *Contains information about a set of real-time metrics.
* @public */ export interface CurrentMetricResult { /** *The dimensions for the metrics.
* @public */ Dimensions?: Dimensions | undefined; /** *The set of metrics.
* @public */ Collections?: CurrentMetricData[] | undefined; } /** * @public */ export interface GetCurrentMetricDataResponse { /** *If there are additional results, this is the token for the next set of results.
*The token expires after 5 minutes from the time it is created. Subsequent requests that use * the token must use the same request parameters as the request that generated the token.
* @public */ NextToken?: string | undefined; /** *Information about the real-time metrics.
* @public */ MetricResults?: CurrentMetricResult[] | undefined; /** *The time at which the metrics were retrieved and cached for pagination.
* @public */ DataSnapshotTime?: Date | undefined; /** *The total count of the result, regardless of the current page size.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters user data based on the contact information that is associated to the users. It contains a list of contact states.
* @public */ export interface ContactFilter { /** *A list of up to 9 contact * states.
* @public */ ContactStates?: ContactState[] | undefined; } /** *A filter for the user data.
* @public */ export interface UserDataFilters { /** *A list of up to 100 queues or ARNs.
* @public */ Queues?: string[] | undefined; /** *A filter for the user data based on the contact information that is associated to the user. It contains a list * of contact states.
* @public */ ContactFilter?: ContactFilter | undefined; /** *A list of up to 100 routing profile IDs or ARNs.
* @public */ RoutingProfiles?: string[] | undefined; /** *A list of up to 100 agent IDs or ARNs.
* @public */ Agents?: string[] | undefined; /** *A UserHierarchyGroup ID or ARN.
* @public */ UserHierarchyGroups?: string[] | undefined; } /** * @public */ export interface GetCurrentUserDataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The filters to apply to returned user data. You can filter up to the following limits:
*Queues: 100
*Routing profiles: 100
*Agents: 100
*Contact states: 9
*User hierarchy groups: 1
*The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can * be passed from queues, routing profiles, agents, and user hierarchy groups.
*Currently tagging is only supported on the resources that are passed in the filter.
* @public */ Filters: UserDataFilters | undefined; /** *The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | undefined; } /** *Information about the hierarchy group.
* @public */ export interface HierarchyGroupSummaryReference { /** *The unique identifier for the hierarchy group.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) for the hierarchy group.
* @public */ Arn?: string | undefined; } /** *Information about the levels in the hierarchy group.
* @public */ export interface HierarchyPathReference { /** *Information about level one.
* @public */ LevelOne?: HierarchyGroupSummaryReference | undefined; /** *Information about level two.
* @public */ LevelTwo?: HierarchyGroupSummaryReference | undefined; /** *Information about level three.
* @public */ LevelThree?: HierarchyGroupSummaryReference | undefined; /** *Information about level four.
* @public */ LevelFour?: HierarchyGroupSummaryReference | undefined; /** *Information about level five.
* @public */ LevelFive?: HierarchyGroupSummaryReference | undefined; } /** *Information about the user.
* @public */ export interface UserReference { /** *The unique identifier for the user.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) for the user.
* @public */ Arn?: string | undefined; } /** *Data for a user.
* @public */ export interface UserData { /** *Information about the user for the data that is returned. It contains the resourceId and ARN of the
* user.
Information about the routing profile that is assigned to the user.
* @public */ RoutingProfile?: RoutingProfileReference | undefined; /** *Contains information about the levels of a hierarchy group assigned to a user.
* @public */ HierarchyPath?: HierarchyPathReference | undefined; /** *The status of the agent that they manually set in their Contact Control Panel (CCP), or that the supervisor * manually changes in the real-time metrics report.
* @public */ Status?: AgentStatusReference | undefined; /** *A map of available slots by channel. The key is a channel name. The value is an integer: the available number of * slots.
* @public */ AvailableSlotsByChannel?: PartialA map of maximum slots by channel. The key is a channel name. The value is an integer: the maximum number of
* slots. This is calculated from MediaConcurrency of the
* RoutingProfile assigned to the agent.
A map of active slots by channel. The key is a channel name. The value is an integer: the number of active * slots.
* @public */ ActiveSlotsByChannel?: PartialA list of contact reference information.
* @public */ Contacts?: AgentContactReference[] | undefined; /** *The Next status of the agent.
* @public */ NextStatus?: string | undefined; } /** * @public */ export interface GetCurrentUserDataResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of the user data that is returned.
* @public */ UserDataList?: UserData[] | undefined; /** *The total count of the result, regardless of the current page size.
* @public */ ApproximateTotalCount?: number | undefined; } /** * @public */ export interface GetEffectiveHoursOfOperationsRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The date from when the hours of operation are listed.
* @public */ FromDate: string | undefined; /** *The date until when the hours of operation are listed.
* @public */ ToDate: string | undefined; } /** *Information about the hours of operations with the effective override applied.
* @public */ export interface OperationalHour { /** *The start time that your contact center opens.
* @public */ Start?: OverrideTimeSlice | undefined; /** *The end time that your contact center closes.
* @public */ End?: OverrideTimeSlice | undefined; } /** *Information about the hours of operations with the effective override applied.
* @public */ export interface EffectiveHoursOfOperations { /** *The date that the hours of operation or overrides applies to.
* @public */ Date?: string | undefined; /** *Information about the hours of operations with the effective override applied.
* @public */ OperationalHours?: OperationalHour[] | undefined; } /** *Information about hours of operation override
* @public */ export interface OverrideHour { /** *The start time or end time for an hours of operation override.
* @public */ Start?: OverrideTimeSlice | undefined; /** *The start time or end time for an hours of operation override.
* @public */ End?: OverrideTimeSlice | undefined; /** *Unique identifier name for the override.
* @public */ OverrideName?: string | undefined; /** *Indicates whether the status is open or closed during the override period. This status determines how the override modifies the base hours of operation schedule.
* @public */ OperationalStatus?: OperationalStatus | undefined; } /** *Information about the hours of operation overrides which contribute to effective hours of operations.
* @public */ export interface EffectiveOverrideHours { /** *The date that the hours of operation override applies to.
* @public */ Date?: string | undefined; /** *Information about the hours of operation overrides that apply to a specific date.
* @public */ OverrideHours?: OverrideHour[] | undefined; } /** * @public */ export interface GetEffectiveHoursOfOperationsResponse { /** *Information about the effective hours of operations.
* @public */ EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined; /** *Information about override configurations applied to the base hours of operation to calculate the effective hours.
*For more information about how override types are applied, see Build your list of overrides in the * Administrator Guide.
* @public */ EffectiveOverrideHoursList?: EffectiveOverrideHours[] | undefined; /** *The time zone for the hours of operation.
* @public */ TimeZone?: string | undefined; } /** * @public */ export interface GetFederationTokenRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains credentials to use for federation.
* @public */ export interface Credentials { /** *An access token generated for a federated user to access Amazon Connect.
* @public */ AccessToken?: string | undefined; /** *A token generated with an expiration time for the session a user is logged in to Amazon Connect.
* @public */ AccessTokenExpiration?: Date | undefined; /** *Renews a token generated for a user to access the Amazon Connect instance.
* @public */ RefreshToken?: string | undefined; /** *Renews the expiration timer for a generated token.
* @public */ RefreshTokenExpiration?: Date | undefined; } /** * @public */ export interface GetFederationTokenResponse { /** *The credentials to use for federation.
* @public */ Credentials?: Credentials | undefined; /** *The URL to sign into the user's instance.
* @public */ SignInUrl?: string | undefined; /** *The Amazon Resource Name (ARN) of the user.
* @public */ UserArn?: string | undefined; /** *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ UserId?: string | undefined; } /** * @public */ export interface GetFlowAssociationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the resource.
*Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER
*
Amazon Web Services End User Messaging Social phone number ARN when using
* WHATSAPP_MESSAGING_PHONE_NUMBER
*
A valid resource type.
* @public */ ResourceType: FlowAssociationResourceType | undefined; } /** * @public */ export interface GetFlowAssociationResponse { /** *The identifier of the resource.
* @public */ ResourceId?: string | undefined; /** *The identifier of the flow.
* @public */ FlowId?: string | undefined; /** *A valid resource type.
* @public */ ResourceType?: FlowAssociationResourceType | undefined; } /** *Contains information about the threshold for service level metrics.
* @public */ export interface Threshold { /** *The type of comparison. Only "less than" (LT) comparisons are supported.
* @public */ Comparison?: Comparison | undefined; /** *The threshold value to compare.
* @public */ ThresholdValue?: number | undefined; } /** *Contains information about a historical metric.
* @public */ export interface HistoricalMetric { /** *The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed * description in the Amazon Connect Administrator Guide.
*Unit: SECONDS
*Statistic: AVG
*UI name: Average queue abandon * time *
*Unit: SECONDS
*Statistic: AVG
*UI name: After contact work time *
*Unit: COUNT
*Statistic: SUM
*UI name: API contacts handled *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average customer hold * time *
*Unit: COUNT
*Statistic: SUM
*UI name: Callback contacts * handled *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts abandoned *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts agent hung up * first *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts consulted *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled * incoming *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled * outbound *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts hold * disconnect *
*Unit: COUNT
*Statistic: SUM
*UI name: AGENT_NON_RESPONSE *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts queued *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred in *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred out * queue *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred * out *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred out * queue *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average handle time *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average * agent interaction and customer hold time *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average agent * interaction time *
*Unit: PERCENT
*Statistic: AVG
*UI name: Occupancy *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average queue answer * time *
*Unit: SECONDS
*Statistic: MAX
*UI name: Minimum flow time *
*You can include up to 20 SERVICE_LEVEL metrics in a request.
*Unit: PERCENT
*Statistic: AVG
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter LT (for "Less than").
UI name: Service level X *
*The threshold for the metric, used with service level metrics.
* @public */ Threshold?: Threshold | undefined; /** *The statistic for the metric.
* @public */ Statistic?: Statistic | undefined; /** *The unit for the metric.
* @public */ Unit?: Unit | undefined; } /** * @public */ export interface GetMetricDataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of * historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, * 10:15.
*The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available * only for 24 hours.
* @public */ StartTime: Date | undefined; /** *The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical * metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be * later than the start time timestamp.
*The time range between the start and end time must be less than 24 hours.
* @public */ EndTime: Date | undefined; /** *The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the * resources associated with the queues or channels included in the filter. You can include both queue IDs and queue * ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
*RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for * more up-to-date features.
*To filter by Queues, enter the queue ID/ARN, not the name of
* the queue.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics * returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all * queues.
*If no grouping is specified, a summary of metrics for all queues is returned.
*RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for * more up-to-date features.
* @public */ Groupings?: Grouping[] | undefined; /** *The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics * are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
*This API does not support a contacts incoming metric (there's * no CONTACTS_INCOMING metric missing from the documented list).
*Unit: SECONDS
*Statistic: AVG
*UI name: Average queue abandon * time *
*Unit: SECONDS
*Statistic: AVG
*UI name: After contact work time *
*Unit: COUNT
*Statistic: SUM
*UI name: API contacts handled *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average customer hold * time *
*Unit: COUNT
*Statistic: SUM
*UI name: Callback contacts * handled *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts abandoned *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts agent hung up * first *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts consulted *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled * incoming *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts handled * outbound *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts hold * disconnect *
*Unit: COUNT
*Statistic: SUM
*UI name: AGENT_NON_RESPONSE *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts queued *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred in *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred out * queue *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred * out *
*Unit: COUNT
*Statistic: SUM
*UI name: Contacts transferred out * queue *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average handle time *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average * agent interaction and customer hold time *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average agent * interaction time *
*Unit: PERCENT
*Statistic: AVG
*UI name: Occupancy *
*Unit: SECONDS
*Statistic: AVG
*UI name: Average queue answer * time *
*Unit: SECONDS
*Statistic: MAX
*UI name: Minimum flow time *
*You can include up to 20 SERVICE_LEVEL metrics in a request.
*Unit: PERCENT
*Statistic: AVG
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter LT (for "Less than").
UI name: Average queue abandon * time *
*The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | undefined; } /** *Contains the data for a historical metric.
* @public */ export interface HistoricalMetricData { /** *Information about the metric.
* @public */ Metric?: HistoricalMetric | undefined; /** *The value of the metric.
* @public */ Value?: number | undefined; } /** *Contains information about the historical metrics retrieved.
* @public */ export interface HistoricalMetricResult { /** *The dimension for the metrics.
* @public */ Dimensions?: Dimensions | undefined; /** *The set of metrics.
* @public */ Collections?: HistoricalMetricData[] | undefined; } /** * @public */ export interface GetMetricDataResponse { /** *If there are additional results, this is the token for the next set of results.
*The token expires after 5 minutes from the time it is created. Subsequent requests that use * the token must use the same request parameters as the request that generated the token.
* @public */ NextToken?: string | undefined; /** *Information about the historical metrics.
*If no grouping is specified, a summary of metric data is returned.
* @public */ MetricResults?: HistoricalMetricResult[] | undefined; } /** *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.
* @public */ export interface FilterV2StringCondition { /** *The string condition.
* @public */ Comparison?: FilterV2StringConditionComparisonOperator | undefined; } /** *Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
* @public */ export interface FilterV2 { /** *The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT,
* CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO,
* AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR,
* AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you
* would add queue IDs or ARNs in FilterValues.
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.
* @public */ StringCondition?: FilterV2StringCondition | undefined; } /** *Information about the interval period to use for returning results.
* @public */ export interface IntervalDetails { /** *The timezone applied to requested metrics.
* @public */ TimeZone?: string | undefined; /** *
* IntervalPeriod: An aggregated grouping applied to request metrics. Valid
* IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR |
* DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and
* EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is
* aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL
* interval period.
The following list describes restrictions on StartTime and EndTime based on what
* IntervalPeriod is requested.
* FIFTEEN_MIN: The difference between StartTime and EndTime must be less
* than 3 days.
* THIRTY_MIN: The difference between StartTime and EndTime must be less
* than 3 days.
* HOUR: The difference between StartTime and EndTime must be less than 3
* days.
* DAY: The difference between StartTime and EndTime must be less than 35
* days.
* WEEK: The difference between StartTime and EndTime must be less than 35
* days.
* TOTAL: The difference between StartTime and EndTime must be less than
* 35 days.
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.
The key to use for filtering data.
*Valid metric filter keys:
*ANSWERING_MACHINE_DETECTION_STATUS
*CASE_STATUS
*DISCONNECT_REASON
*FLOWS_ACTION_IDENTIFIER
*FLOWS_NEXT_ACTION_IDENTIFIER
*FLOWS_OUTCOME_TYPE
*FLOWS_RESOURCE_TYPE
*INITIATION_METHOD
*The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a * customized list, depending on the use case.
*For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and
* ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the
* Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome
* metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for
* the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the
* Bot
* intents completed metric in the Amazon Connect Administrator Guide.
If set to true, the API response contains results that filter out the results matched by the
* metric-level filters condition. By default, Negate is set to false.
Contains information about the threshold for service level metrics.
* @public */ export interface ThresholdV2 { /** *The type of comparison. Currently, "less than" (LT), "less than equal" (LTE), and "greater than" (GT) * comparisons are supported.
* @public */ Comparison?: string | undefined; /** *The threshold value to compare.
* @public */ ThresholdValue?: number | undefined; } /** *Contains information about the metric.
*Only one of either the Name or MetricId is required.
*The name of the metric.
* @public */ Name?: string | undefined; /** *Contains information about the threshold for service level metrics.
* @public */ Threshold?: ThresholdV2[] | undefined; /** *Historical metrics or custom metrics can be referenced via this field. This field is a valid Amazon Connect * Arn or a UUID
* @public */ MetricId?: string | undefined; /** *Contains the filters to be used when returning data.
* @public */ MetricFilters?: MetricFilterV2[] | undefined; } /** * @public */ export interface GetMetricDataV2Request { /** *The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
* historical metrics data. The time must be before the end time timestamp. The start and end time depends on the
* IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical
* metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical * metrics data. The time must be later than the start time timestamp. It cannot be later than the current * timestamp.
* @public */ EndTime: Date | undefined; /** *The interval period and timezone to apply to returned metrics.
*
* IntervalPeriod: An aggregated grouping applied to request metrics. Valid
* IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR |
* DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and
* EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is
* aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the
* TOTAL interval period.
The following list describes restrictions on StartTime and EndTime based on which
* IntervalPeriod is requested.
* FIFTEEN_MIN: The difference between StartTime and EndTime must be
* less than 3 days.
* THIRTY_MIN: The difference between StartTime and EndTime must be less
* than 3 days.
* HOUR: The difference between StartTime and EndTime must be less than
* 3 days.
* DAY: The difference between StartTime and EndTime must be less than
* 35 days.
* WEEK: The difference between StartTime and EndTime must be less than
* 35 days.
* TOTAL: The difference between StartTime and EndTime must be less than
* 35 days.
* TimeZone: The timezone applied to requested metrics.
Filtering is an operation that selects records that match a set of specified criteria. By narrowing the dataset * before aggregation, filters ensure that only relevant records are included in the computation.
** Filter keys *
*The following are valid filter keys for a GetMetricDataV2 request:
* AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO |
* AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR |
* AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS |
* BOT_ALIAS | BOT_ID | BOT_INTENT_NAME | BOT_LOCALE |
* BOT_VERSION | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE |
* CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_STATUS | CASE_TEMPLATE_ARN |
* CHANNEL | contact/segmentAttributes/connect:Subtype |
* contact/segmentAttributes/connect:ValidationTestType | DISCONNECT_REASON |
* EVALUATION_FORM | EVALUATION_QUESTION | EVALUATION_SECTION |
* EVALUATION_SOURCE | EVALUATOR_ID | FEATURE |
* FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID |
* FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID |
* FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION |
* INITIATING_FLOW | INITIATION_METHOD |
* INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE |
* PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE |
* RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE |
* ROUTING_STEP_EXPRESSION | TEST_CASE |
* TEST_CASE_EXECUTION_FAILURE_REASON | TEST_CASE_EXECUTION_RESULT |
* TEST_CASE_EXECUTION_STATE
*
The following filter keys correspond to Amazon Connect resources and are used for authorizing requests.
* A GetMetricDataV2 request requires at least one of these filters:
* QUEUE, ROUTING_PROFILE, AGENT,
* AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO,
* AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR,
* AGENT_HIERARCHY_LEVEL_FIVE, CAMPAIGN, EVALUATION_FORM,
* EVALUATOR_ID
*
You can use up to 5 filter keys in a single request, and up to 100 filter values across all filter keys.
** Filter values *
*VOICE, CHAT, TASK, and EMAIL are valid filter values for the CHANNEL filter key. They do not
* count towards the limit of 100 filter values. For example, a GetMetricDataV2 request can filter by
* 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 4 channel
* filters.
* contact_lens_conversational_analytics is a valid filter value for the FEATURE
* filter key. It is available only for contacts analyzed by Contact Lens conversational analytics.
* connect:Chat, connect:SMS, connect:Telephony, and
* connect:WebRTC are valid filter value examples (not exhaustive) for the
* contact/segmentAttributes/connect:Subtype filter key.
* ROUTING_STEP_EXPRESSION accepts a filter value up to 3,000 characters in length. This filter
* is case-sensitive and order-sensitive. JSON string fields must be sorted in ascending order, and JSON array order
* must be preserved.
TRUE and FALSE are the only valid filter values for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Connect AI Agents enabled as part of the flow.
*FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow.
*
* EXPERIENCE_VALIDATION and FLOW_VALIDATION are the only valid filter values for the
* contact/segmentAttributes/connect:ValidationTestType filter key. This filter is available only for
* contact record-driven metrics.
* Campaign ARNs are valid filter values for the CAMPAIGN filter key.
To filter by phone number, see Create a historical metrics report in * the Amazon Connect Administrator Guide.
*The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the * metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not * aggregated for all queues.
*If no grouping is specified, a summary of all metrics is returned.
*Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE |
* AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE |
* AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE |
* ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS |
* BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN |
* CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE |
* CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS |
* CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON |
* EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION |
* EVALUATION_SOURCE | EVALUATOR_ID | FLOWS_RESOURCE_ID |
* FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE |
* FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD |
* INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE |
* PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE |
* RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION |
* TEST_CASE | TEST_CASE_EXECUTION_FAILURE_REASON | TEST_CASE_INVOCATION_METHOD
*
API, SCHEDULE, and EVENT are the only valid filterValues for TEST_CASE_INVOCATION_METHOD.
*OBSERVE_EVENT, SEND_INSTRUCTION, ASSERT_DATA, and OVERRIDE_SYSTEM_BEHAVIOR are the only valid filterValues for * TEST_CASE_EXECUTION_FAILURE_REASON
*Type: Array of strings
*Array Members: Maximum number of 4 items
*Required: No
* @public */ Groupings?: string[] | undefined; /** *The metrics to retrieve. Specify the name or metricId, groupings, and filters for each metric. The following * historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
*MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the * limit is 20 MetricId per request.
*Unit: Percent
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Abandonment rate *
*This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Adherent time *
*Unit: Percent
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Agent answer rate *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Non-adherent time *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Agent non-response *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
* *Unit: Percentage
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Occupancy *
*This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
*Unit: Percent
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Adherence *
*This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Scheduled time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*Valid metric filter key: INITIATION_METHOD
*
UI name: Average queue abandon * time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Average active time *
*Unit: Seconds
*Valid metric filter key: INITIATION_METHOD
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average after contact work * time *
*Feature is a valid filter but not a valid grouping.
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Average agent * concurrency *
*Unit: Seconds
*Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as
* INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK |
* API
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Average agent API * connecting time *
*The Negate key in metric-level filters is not applicable for this metric.
Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Average agent pause * time *
*Unit: Seconds
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, * Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Average bot conversation * time *
*Unit: Count
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, * Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Average bot conversation * turns *
*Unit: Count
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Average contacts per * case *
*Unit: Seconds
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Average case resolution * time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average contact * duration *
*Feature is a valid filter but not a valid grouping.
*Unit: Seconds
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
* *Unit: Seconds
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average conversation * close time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average conversation * duration *
*This metric is available only for outbound campaigns that use the agent assisted voice and automated voice * delivery modes.
*Unit: Count
*Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
*UI name: Average dials per * minute *
*Unit: Percent
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question * ID, Evaluation Source, Form Version, Queue, Routing Profile
*UI name: Average evaluation * score *
*Unit: Seconds
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average agent first * response time *
*Unit: Seconds
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource * published timestamp
*UI name: Average flow time *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average agent greeting * time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, RoutingStepExpression
*UI name: Average handle time *
*Feature is a valid filter but not a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing * Profile
*UI name: Active AI Agents *
*Unit: Percent
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Handoff Rate *
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Handoffs *
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, * Channel, Queue, Routing Profile
*UI name: AI Agent Invocation Success *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Percent
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, * Channel, Queue, Routing Profile
*UI name: AI Agent Invocation Success Rate *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Agent Name Version, AI Use Case, * Channel, Queue, Routing Profile
*UI name: AI Agent Invocations *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Percent
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Response Completion Rate *
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Involved Contacts *
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI * Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Prompt Invocation Success *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Percent
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI * Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Prompt Invocation Success Rate *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI * Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Prompt Invocations *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI * Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Tool Invocation Success *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Percent
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI * Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Tool Invocation Success Rate *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI * Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: AI Tool Invocations *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, * Channel, Queue, Routing Profile
*UI name: Average AI Agent Conversation Turns *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Average AI Conversation Turns *
*Unit: Milliseconds
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI * Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: Average AI Prompt Invocation Latency *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Milliseconds
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI * Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
*UI name: Average AI Tool Invocation Latency *
*AI Agent Name Version is not a valid filter but a valid grouping.
*Unit: Count
*Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Knowledge Base * Name, Queue, Routing Profile
*UI name: Knowledge Content References *
*Unit: Percent
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Proactive Intent Engagement Rate *
*Unit: Percent
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Proactive Intent Response Rate *
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Proactive Intents Answered *
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Proactive Intents Detected *
*Unit: Count
*Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
*UI name: Proactive Intents Engaged *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average customer hold * time *
*Feature is a valid filter but not a valid grouping.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average customer * hold time all contacts *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average holds *
*Feature is a valid filter but not a valid grouping.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average * agent interaction and customer hold time *
*Unit: Seconds
*Valid metric filter key: INITIATION_METHOD
*
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, * Q in Connect
*UI name: Average agent interaction * time *
*Feature is a valid filter but not a valid grouping.
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average agent * interruptions *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average agent * interruption time *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average agent message * length *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average customer message * length *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average messages *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average agent * messages *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average bot messages *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average customer * messages *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average non-talk time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, * Q in Connect
*UI name: Average queue answer * time *
*Valid metric level filters: INITIATION_METHOD, FEATURE,
* DISCONNECT_REASON
*
Feature is a valid filter but not a valid grouping.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in * Connect, Agent Hierarchy
*UI name: Avg. * queue answer time - customer first callback *
*Unit: Seconds
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average agent response * time *
*Unit: Seconds
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Average customer response * time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average resolution time *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average talk time *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average agent talk time *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Average customer talk * time *
*This metric is available only for outbound campaigns that use the agent assisted voice and automated voice * delivery modes.
*Unit: Seconds
*Valid groupings and filters: Campaign
* *Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in * Connect, Agent Hierarchy
*UI name: Avg. wait time after customer connection - customer first callback *
*Unit: Percent
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question * ID, Evaluation Source, Form Version, Queue, Routing Profile
*UI name: Average weighted * evaluation score *
*Unit: Count
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, * Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Bot conversations completed *
*Unit: Count
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource * published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Bot intents completed *
*This metric is available only for outbound campaigns using the agent assisted voice and automated voice * delivery modes.
*Unit: Count
*Valid groupings and filters: Agent, Campaign
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts * abandoned after X *
*This metric is available only for outbound campaigns using the agent assisted voice and automated voice * delivery modes.
*Unit: Percent
*Valid groupings and filters: Agent, Campaign
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you must enter GT (for Greater than).
UI name: Campaign * contacts abandoned after X rate *
*This metric is available only for outbound campaigns using the email delivery mode.
*Unit: Count
*Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
*Valid groupings and filters: Campaign
*UI name: Campaign interactions *
*This metric is only available for outbound campaigns initiated using a customer segment. It is not available * for event triggered campaigns.
*Unit: Percent
*Valid groupings and filters: Campaign, Campaign Execution Timestamp
*UI name: Campaign progress rate *
*This metric is available only for outbound campaigns.
*Unit: Count
*Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
*UI name: Campaign send attempts *
*This metric is available only for outbound campaigns.
*Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
*Unit: Count
*Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
*UI name: Campaign send * exclusions *
*Unit: Count
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Cases created *
*Unit: Count
*Valid metric filter key: INITIATION_METHOD
*
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, * Q in Connect
*UI name: Contacts created *
*Feature is a valid filter but not a valid grouping.
*Unit: Count
*Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
*UI name: Contacts handled *
*Feature is a valid filter but not a valid grouping.
*Unit: Count
*Valid metric filter key: INITIATION_METHOD
*
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, * Q in Connect
* *Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contacts hold * disconnect *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contacts hold agent * disconnect *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contacts hold customer * disconnect *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contacts put on hold *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contacts transferred * out external *
*Unit: Percent
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contacts transferred * out internal *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contacts queued *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
*UI name: Contacts queued (enqueue * timestamp) *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you can use LT (for "Less than") or LTE (for "Less than
* equal").
UI name: Contacts removed from queue * in X seconds *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you can use LT (for "Less than") or LTE (for "Less than
* equal").
UI name: Contacts resolved in X *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contacts transferred * out *
*Feature is a valid filter but not a valid grouping.
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contacts transferred * out by agent *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contacts transferred out * queue *
*Unit: Count
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Current cases *
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, * Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
*UI name: Conversations * abandoned *
*This metric is available only for outbound campaigns.
*Unit: Count
*Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,
* CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
*
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, * contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
*UI name: Delivery attempts *
*Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery * modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available * for agent assisted voice and automated voice delivery modes.
*This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated * voice delivery modes are only available with answering machine detection enabled.
*Unit: Percent
*Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS,
* CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
*
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, * contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
*UI name: Delivery attempt * disposition rate *
*Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery * modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available * for agent assisted voice and automated voice delivery modes.
*Unit: Count
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, * Routing Profile
*UI name: Evaluations * performed *
*Unit: Count
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource * published timestamp
*UI name: Flows outcome *
*Unit: Count
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * resource ID, Initiation method, Resource published timestamp
*UI name: Flows started *
*This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated * voice delivery modes are only available with answering machine detection enabled.
*Unit: Count
*Valid groupings and filters: Agent, Campaign
*UI name: Human answered *
*Unit: Seconds
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource * published timestamp
*UI name: Maximum flow time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Maximum queued time *
*Unit: Seconds
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource * published timestamp
*UI name: Minimum flow time *
*Unit: Percent
*Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, * Routing Profile
*UI name: Automatic fails percent *
*Unit: Percent
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, * Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Percent bot conversations * outcome *
*Unit: Percent
*Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, * Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource * published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
*UI name: Percent bot intents outcome *
*Unit: Percent
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Cases resolved on first * contact *
*Unit: Percent
*Valid groupings and filters: Queue, RoutingStepExpression
*UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
*Unit: Percent
*Valid groupings and filters: Queue, RoutingStepExpression
*UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
*Unit: Percent
*Valid metric filter key: FLOWS_OUTCOME_TYPE
*
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows * next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource * published timestamp
*UI name: Flows outcome * percentage.
*The FLOWS_OUTCOME_TYPE is not a valid grouping.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Percentage
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Non-talk time percent *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Percentage
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Talk time percent *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Percentage
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Agent talk time percent *
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
*Unit: Percentage
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Customer talk time * percent *
*This metric is only available for outbound campaigns initiated using a customer segment. It is not available * for event triggered campaigns.
*Unit: Count
*Valid groupings and filters: Campaign, Campaign Execution Timestamp
*UI name: Recipients attempted *
*This metric is only available for outbound campaigns initiated using a customer segment. It is not available * for event triggered campaigns.
*Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
*Unit: Count
*Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution * Timestamp
*UI name: Recipients interacted *
*This metric is only available for outbound campaigns initiated using a customer segment. It is not available * for event triggered campaigns.
*Unit: Count
*Valid groupings and filters: Campaign, Campaign Execution Timestamp
*UI name: Recipients targeted *
*Unit: Count
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Cases reopened *
*Unit: Count
*Required filter key: CASE_TEMPLATE_ARN
*Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
*UI name: Cases resolved *
*You can include up to 20 SERVICE_LEVEL metrics in a request.
*Unit: Percent
*Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you can use LT (for "Less than") or LTE (for "Less than
* equal").
UI name: Service level X *
*Unit: Count
*Valid groupings and filters: Queue, RoutingStepExpression
*UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: After contact work time *
*Unit: Seconds
*Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys
* as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK |
* API | CALLBACK_CUSTOMER_FIRST_DIALED
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Agent API connecting * time *
*The Negate key in metric-level filters is not applicable for this metric.
Unit: Count
*Metric filter:
*Valid values: API| INCOMING | OUTBOUND | TRANSFER |
* CALLBACK | QUEUE_TRANSFER| Disconnect |
* CALLBACK_CUSTOMER_FIRST_DIALED
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
*UI name: Contact abandoned *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you can use LT (for "Less than") or LTE (for "Less than
* equal").
UI name: Contacts abandoned in X * seconds *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
*Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds.
* For Comparison, you can use LT (for "Less than") or LTE (for "Less than
* equal").
UI name: Contacts answered in X * seconds *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contact flow time *
*Unit: Seconds
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Agent on contact time *
*Valid metric filter key: DISCONNECT_REASON
*
Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, * contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Contact disconnected *
*Unit: Seconds
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Error status time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Contact handle time *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Customer hold time *
*Unit: Seconds
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Agent idle time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
*UI name: Agent interaction and * hold time *
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*UI name: Agent interaction time *
*Unit: Seconds
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Agent non-productive * time *
*Unit: Seconds
*Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
*UI name: Online time *
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
*UI name: Callback attempts *
*The token for the next set of results. Use the value returned in the previous * response in the next request to retrieve the next set of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | undefined; } /** *Contains the name, thresholds, and metric filters.
* @public */ export interface MetricDataV2 { /** *The metric name or metricId, thresholds, and metric filters of the returned metric.
* @public */ Metric?: MetricV2 | undefined; /** *The corresponding value of the metric returned in the response.
* @public */ Value?: number | undefined; } /** *The interval period with the start and end time for the metrics.
* @public */ export interface MetricInterval { /** *The interval period provided in the API request.
* @public */ Interval?: IntervalPeriod | undefined; /** *The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
* @public */ StartTime?: Date | undefined; /** *The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If
* IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime in
* the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30
* minutes period, with each StartTime and EndTime differing by 30 minutes.
Contains information about the metric results.
* @public */ export interface MetricResultV2 { /** *The dimension for the metrics.
* @public */ Dimensions?: RecordThe interval period with the start and end time for the metrics.
* @public */ MetricInterval?: MetricInterval | undefined; /** *The set of metrics.
* @public */ Collections?: MetricDataV2[] | undefined; } /** * @public */ export interface GetMetricDataV2Response { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the metrics requested in the API request If no grouping is specified, a summary of metric data * is returned.
* @public */ MetricResults?: MetricResultV2[] | undefined; }