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 GetPromptFileResponse { /** *A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in * S3.
* @public */ PromptPresignedUrl?: 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; } /** * @public */ export interface GetTaskTemplateRequest { /** *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; /** *The system generated version of a task template that is associated with a task, when the task is created.
* @public */ SnapshotVersion?: string | undefined; } /** * @public */ export interface GetTaskTemplateResponse { /** *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 */ Id: string | undefined; /** *The Amazon Resource Name (ARN).
* @public */ Arn: string | undefined; /** *The name of the task template.
* @public */ Name: string | undefined; /** *The description of the task template.
* @public */ Description?: string | undefined; /** *The identifier of the flow that runs by default when a task is created by referencing this template.
* @public */ ContactFlowId?: string | undefined; /** *The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
* @public */ SelfAssignFlowId?: string | undefined; /** *Constraints that are applicable to the fields listed.
* @public */ Constraints?: TaskTemplateConstraints | undefined; /** *The default values for fields when a task is created by referencing this template.
* @public */ Defaults?: TaskTemplateDefaults | undefined; /** *Fields that are part of the template.
* @public */ Fields?: TaskTemplateField[] | undefined; /** *Marks a template as ACTIVE or INACTIVE for a task to refer to it.
* Tasks can only be created from ACTIVE templates.
* If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
The timestamp when the task template was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The timestamp when the task template was created.
* @public */ CreatedTime?: Date | 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 test case.
* @public */ TestCaseId: string | undefined; /** *The identifier of the test case execution.
* @public */ TestCaseExecutionId: string | undefined; } /** *Contains summary statistics about a test case execution.
* @public */ export interface ObservationSummary { /** *The total number of observations in the test case.
* @public */ TotalObservations?: number | undefined; /** *The number of observations that passed during execution.
* @public */ ObservationsPassed?: number | undefined; /** *The number of observations that failed during execution.
* @public */ ObservationsFailed?: number | undefined; } /** * @public */ export interface GetTestCaseExecutionSummaryResponse { /** *The timestamp when the test case execution started.
* @public */ StartTime?: Date | undefined; /** *The timestamp when the test case execution ended.
* @public */ EndTime?: Date | undefined; /** *The status of the test case execution.
* @public */ Status?: TestCaseExecutionStatus | undefined; /** *Summary statistics for the test case execution.
* @public */ ObservationSummary?: ObservationSummary | undefined; } /** * @public */ export interface GetTrafficDistributionRequest { /** *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 distribution of sign in traffic between the instance and its replica(s).
* @public */ export interface SignInDistribution { /** *The Amazon Web Services Region of the sign in distribution.
* @public */ Region: string | undefined; /** *Whether sign in distribution is enabled.
* @public */ Enabled: boolean | undefined; } /** *The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both * the instance and its replica(s).
* @public */ export interface SignInConfig { /** *Information about traffic distributions.
* @public */ Distributions: SignInDistribution[] | undefined; } /** *The distribution of traffic between the instance and its replicas.
* @public */ export interface TelephonyConfig { /** *Information about traffic distributions.
* @public */ Distributions: Distribution[] | undefined; } /** * @public */ export interface GetTrafficDistributionResponse { /** *The distribution of traffic between the instance and its replicas.
* @public */ TelephonyConfig?: TelephonyConfig | undefined; /** *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 distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both * the instance and its replica(s).
* @public */ SignInConfig?: SignInConfig | undefined; /** *The distribution of agents between the instance and its replica(s).
* @public */ AgentConfig?: AgentConfig | undefined; } /** * @public */ export interface ImportPhoneNumberRequest { /** *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 claimed phone number ARN being 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 to import * from Amazon Web Services End User Messaging.
* @public */ SourcePhoneNumberArn: string | undefined; /** *The description of the phone number.
* @public */ PhoneNumberDescription?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordA 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 ImportPhoneNumberResponse { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId?: string | undefined; /** *The Amazon Resource Name (ARN) of the phone number.
* @public */ PhoneNumberArn?: string | undefined; } /** * @public */ export interface ImportWorkspaceMediaRequest { /** *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. Valid values are: IMAGE_LOGO_FAVICON and
* IMAGE_LOGO_HORIZONTAL.
The media source. Can be an S3 presigned URL or a base64-encoded string.
* @public */ MediaSource: string | undefined; } /** * @public */ export interface ImportWorkspaceMediaResponse { } /** * @public */ export interface ListAgentStatusRequest { /** *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 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; /** *Available agent status types.
* @public */ AgentStatusTypes?: AgentStatusType[] | undefined; } /** * @public */ export interface ListAgentStatusResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A summary of agent statuses.
* @public */ AgentStatusSummaryList?: AgentStatusSummary[] | undefined; } /** * @public */ export interface ListAnalyticsDataAssociationsRequest { /** *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 get the association status.
* @public */ DataSetId?: string | 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; } /** * @public */ export interface ListAnalyticsDataAssociationsResponse { /** *An array of successful results: DataSetId, TargetAccountId,
* ResourceShareId, ResourceShareArn. This is a paginated API, so nextToken is
* given if there are more results to be returned.
If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAnalyticsDataLakeDataSetsRequest { /** *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 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 datasets that are available to associate with: DataSetId,
* DataSetName.
The identifier of the dataset.
* @public */ DataSetId?: string | undefined; /** *The name of the dataset.
* @public */ DataSetName?: string | undefined; } /** * @public */ export interface ListAnalyticsDataLakeDataSetsResponse { /** *An array of successful results: DataSetId, DataSetName. This is a paginated API, so
* nextToken is given if there are more results to be returned.
If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListApprovedOriginsRequest { /** *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 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; } /** * @public */ export interface ListApprovedOriginsResponse { /** *The approved origins.
* @public */ Origins?: string[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAssociatedContactsRequest { /** *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; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Contact summary of a contact in contact tree associated with unique identifier.
* @public */ export interface AssociatedContactSummary { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId?: string | undefined; /** *The Amazon Resource Name (ARN) of the contact
* @public */ ContactArn?: string | undefined; /** *The date and time this contact was initiated, in UTC time.
* @public */ InitiationTimestamp?: Date | undefined; /** *The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer * scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact * ended.
* @public */ DisconnectTimestamp?: Date | undefined; /** *If this contact is related to other contacts, this is the ID of the initial contact.
* @public */ InitialContactId?: string | undefined; /** *If this contact is not the first contact, this is the ID of the previous contact.
* @public */ PreviousContactId?: string | undefined; /** *The contactId that is related to this contact.
* @public */ RelatedContactId?: string | undefined; /** *Indicates how the contact was initiated.
* @public */ InitiationMethod?: ContactInitiationMethod | undefined; /** *How the contact reached your contact center.
* @public */ Channel?: Channel | undefined; } /** * @public */ export interface ListAssociatedContactsResponse { /** *List of the contact summary for all the contacts in contact tree associated with unique identifier.
* @public */ ContactSummaryList?: AssociatedContactSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAttachedFilesConfigurationsRequest { /** *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 maximum number of results to return per page. The default MaxResult size is 100.
* @public */ MaxResults?: number | 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; } /** *A summary of the attached files configuration.
* @public */ export interface AttachedFilesConfigurationSummary { /** *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. The minimum value is 1 and the maximum value is 104857600 (100 MB).
* @public */ MaximumSizeLimitInBytes?: number | undefined; /** *The configuration for allowed file extensions.
* @public */ ExtensionConfiguration?: ExtensionConfiguration | undefined; } /** * @public */ export interface ListAttachedFilesConfigurationsResponse { /** *Information about the attached files configurations.
* @public */ AttachedFilesConfigurations?: AttachedFilesConfigurationSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAuthenticationProfilesRequest { /** *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 maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *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.
*A summary of a given authentication profile.
* @public */ export interface AuthenticationProfileSummary { /** *The unique identifier of the authentication profile.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the authentication profile summary.
* @public */ Arn?: string | undefined; /** *The name of the authentication profile summary.
* @public */ Name?: 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 summary was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Amazon Web Services Region when the authentication profile summary was last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListAuthenticationProfilesResponse { /** *A summary of a given authentication profile.
* @public */ AuthenticationProfileSummaryList?: AuthenticationProfileSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListBotsRequest { /** *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 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; /** *The version of Amazon Lex or Amazon Lex V2.
* @public */ LexVersion: LexVersion | undefined; } /** *Configuration information of an Amazon Lex or Amazon Lex V2 bot.
* @public */ export interface LexBotConfig { /** *Configuration information of an Amazon Lex bot.
* @public */ LexBot?: LexBot | undefined; /** *Configuration information of an Amazon Lex V2 bot.
* @public */ LexV2Bot?: LexV2Bot | undefined; } /** * @public */ export interface ListBotsResponse { /** *The names and Amazon Web Services Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified * instance.
* @public */ LexBots?: LexBotConfig[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListChildHoursOfOperationsRequest { /** *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 parent hours of operation.
* @public */ HoursOfOperationId: string | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListChildHoursOfOperationsResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the hours of operation.
* @public */ ChildHoursOfOperationsSummaryList?: HoursOfOperationsIdentifier[] | 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 ListContactEvaluationsRequest { /** *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; /** *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.
*This is not expected to be set because the value returned in the previous response is always null.
*Summary information about an evaluation acknowledgement.
* @public */ export interface EvaluationAcknowledgementSummary { /** *The time when an 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; } /** *Summary information about a contact evaluation.
* @public */ export interface EvaluationSummary { /** *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; /** *A title of the evaluation form.
* @public */ EvaluationFormTitle: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *The calibration session ID that this evaluation belongs to.
* @public */ CalibrationSessionId?: string | undefined; /** *The status of the contact evaluation.
* @public */ Status: EvaluationStatus | undefined; /** *Whether automated evaluation is enabled.
* @public */ AutoEvaluationEnabled?: boolean | undefined; /** *The status of the contact auto evaluation.
* @public */ AutoEvaluationStatus?: AutoEvaluationStatus | undefined; /** *The Amazon Resource Name (ARN) of the user who last updated the evaluation.
* @public */ EvaluatorArn: string | undefined; /** *The overall score of the contact evaluation.
* @public */ Score?: EvaluationScore | undefined; /** *Information related to evaluation acknowledgement.
* @public */ Acknowledgement?: EvaluationAcknowledgementSummary | undefined; /** *Type of the evaluation.
* @public */ EvaluationType?: EvaluationType | undefined; /** *The timestamp for when the evaluation was created.
* @public */ CreatedTime: Date | undefined; /** *The timestamp for when the evaluation was last updated.
* @public */ LastModifiedTime: Date | undefined; /** *Information about a contact participant in the evaluation.
* @public */ ContactParticipant?: EvaluationContactParticipant | undefined; } /** * @public */ export interface ListContactEvaluationsResponse { /** *Provides details about a list of contact evaluations belonging to an instance.
* @public */ EvaluationSummaryList: EvaluationSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
*This is always returned as null in the response.
*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 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 information about an alias.
* @public */ export interface ContactFlowModuleAliasSummary { /** *The Amazon Resource Name (ARN) of the flow module alias.
* @public */ Arn?: 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 */ AliasName?: string | undefined; /** *The description of the alias.
* @public */ AliasDescription?: string | undefined; /** *The timestamp when this resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface ListContactFlowModuleAliasesResponse { /** *Information about the flow module aliases.
* @public */ ContactFlowModuleAliasSummaryList?: ContactFlowModuleAliasSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListContactFlowModulesRequest { /** *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 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; /** *The state of the flow module.
* @public */ ContactFlowModuleState?: ContactFlowModuleState | undefined; } /** *Contains summary information about a flow.
* @public */ export interface ContactFlowModuleSummary { /** *The identifier of the flow module.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the flow module.
* @public */ Arn?: string | undefined; /** *The name of the flow module.
* @public */ Name?: string | undefined; /** *The type of flow module.
* @public */ State?: ContactFlowModuleState | undefined; } /** * @public */ export interface ListContactFlowModulesResponse { /** *Information about the flow module.
* @public */ ContactFlowModulesSummaryList?: ContactFlowModuleSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListContactFlowModuleVersionsRequest { /** *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 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 information about a version.
* @public */ export interface ContactFlowModuleVersionSummary { /** *The Amazon Resource Name (ARN) of the flow module version.
* @public */ Arn?: string | undefined; /** *The description of the flow module version.
* @public */ VersionDescription?: string | undefined; /** *The version of the flow module.
* @public */ Version?: number | undefined; } /** * @public */ export interface ListContactFlowModuleVersionsResponse { /** *Information about the flow module versions.
* @public */ ContactFlowModuleVersionSummaryList?: ContactFlowModuleVersionSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListContactFlowsRequest { /** *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 flow.
* @public */ ContactFlowTypes?: ContactFlowType[] | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a flow.
*You can also create and update flows using the Amazon Connect * Flow language.
* @public */ export interface ContactFlowSummary { /** *The identifier of the flow.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the flow.
* @public */ Arn?: string | undefined; /** *The name of the flow.
* @public */ Name?: string | undefined; /** *The type of flow.
* @public */ ContactFlowType?: ContactFlowType | undefined; /** *The type of flow.
* @public */ ContactFlowState?: ContactFlowState | undefined; /** *The status of the flow.
* @public */ ContactFlowStatus?: ContactFlowStatus | undefined; } /** * @public */ export interface ListContactFlowsResponse { /** *Information about the flows.
* @public */ ContactFlowSummaryList?: ContactFlowSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListContactFlowVersionsRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *A summary of a flow version's metadata.
* @public */ export interface ContactFlowVersionSummary { /** *The Amazon Resource Name (ARN) of the view version.
* @public */ Arn?: string | undefined; /** *The description of the flow version.
* @public */ VersionDescription?: string | undefined; /** *The identifier of the flow version.
* @public */ Version?: number | undefined; } /** * @public */ export interface ListContactFlowVersionsResponse { /** *A list of flow version summaries.
* @public */ ContactFlowVersionSummaryList?: ContactFlowVersionSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListContactReferencesRequest { /** *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 initial contact.
* @public */ ContactId: string | undefined; /** *The type of reference.
* @public */ ReferenceTypes: ReferenceType[] | 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.
*This is not expected to be set, because the value returned in the previous response is always null.
*Information about a reference when the referenceType is ATTACHMENT. Otherwise,
* null.
Identifier of the attachment reference.
* @public */ Name?: string | undefined; /** *The location path of the attachment reference.
* @public */ Value?: string | undefined; /** *Status of the attachment reference type.
* @public */ Status?: ReferenceStatus | undefined; /** *The Amazon Resource Name (ARN) of the attachment reference.
* @public */ Arn?: string | undefined; } /** *Information about a reference when the referenceType is DATE. Otherwise, null.
Identifier of the date reference.
* @public */ Name?: string | undefined; /** *A valid date.
* @public */ Value?: string | undefined; } /** *Information about a reference when the referenceType is EMAIL. Otherwise, null.
Identifier of the email reference.
* @public */ Name?: string | undefined; /** *A valid email address.
* @public */ Value?: string | undefined; } /** *Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
The name of the email message reference
* @public */ Name?: string | undefined; /** *The Amazon Resource Name (ARN) of the email message reference
* @public */ Arn?: string | undefined; } /** *Information about a reference when the referenceType is NUMBER. Otherwise,
* null.
Identifier of the number reference.
* @public */ Name?: string | undefined; /** *A valid number.
* @public */ Value?: string | undefined; } /** *Information about a reference when the referenceType is STRING. Otherwise,
* null.
Identifier of the string reference.
* @public */ Name?: string | undefined; /** *A valid string.
* @public */ Value?: string | undefined; } /** *The URL reference.
* @public */ export interface UrlReference { /** *Identifier of the URL reference.
* @public */ Name?: string | undefined; /** *A valid URL.
* @public */ Value?: string | undefined; } /** *Contains summary information about a reference. ReferenceSummary contains only one non null field
* between the URL and attachment based on the reference type.
Information about the reference when the referenceType is URL. Otherwise, null.
Information about the reference when the referenceType is ATTACHMENT. Otherwise,
* null.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Information about a reference when the referenceType is STRING. Otherwise,
* null.
Information about a reference when the referenceType is NUMBER. Otherwise,
* null.
Information about a reference when the referenceType is DATE. Otherwise, null.
Information about a reference when the referenceType is EMAIL. Otherwise, null.
Information about the flows.
* @public */ ReferenceSummaryList?: ReferenceSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
*This is always returned as null in the response.
*The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table whose attributes should be listed.
* @public */ DataTableId: string | undefined; /** *Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes * by ID. If NextToken is provided, this parameter is ignored.
* @public */ AttributeIds?: 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 attributes to return in one page of results.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListDataTableAttributesResponse { /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *A list of data table attributes with their complete configuration and metadata.
* @public */ Attributes: DataTableAttribute[] | undefined; } /** *A primary attribute value filter.
* @public */ export interface PrimaryAttributeValueFilter { /** *The filter's attribute name.
* @public */ AttributeName: string | undefined; /** *The filter's values.
* @public */ Values: string[] | undefined; } /** * @public */ export interface ListDataTablePrimaryValuesRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table whose primary values should be listed.
* @public */ DataTableId: string | undefined; /** *Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. * If NextToken is provided, this parameter is ignored.
* @public */ RecordIds?: string[] | undefined; /** *Optional filter to retrieve primary values matching specific criteria.
* @public */ PrimaryAttributeValues?: PrimaryAttributeValueFilter[] | 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 primary values to return in one page of results.
* @public */ MaxResults?: number | undefined; } /** *A record primary value.
* @public */ export interface RecordPrimaryValue { /** *The value's record ID.
* @public */ RecordId?: string | undefined; /** *The value's primary values.
* @public */ PrimaryValues?: PrimaryValueResponse[] | undefined; /** *The value's last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *The value's last modified region.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListDataTablePrimaryValuesResponse { /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *A list of primary value combinations with their record IDs and modification metadata.
* @public */ PrimaryValuesList: RecordPrimaryValue[] | undefined; } /** * @public */ export interface ListDataTablesRequest { /** *The unique identifier for the Amazon Connect instance whose data tables should be listed.
* @public */ InstanceId: 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 tables to return in one page of results.
* @public */ MaxResults?: number | undefined; } /** *A data table summary.
* @public */ export interface DataTableSummary { /** *The summary's name.
* @public */ Name?: string | undefined; /** *The summary's ID.
* @public */ Id?: string | undefined; /** *The summary's ARN.
* @public */ Arn?: string | undefined; /** *The summary's last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *The summary's last modified region.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListDataTablesResponse { /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *A list of data table summaries containing basic information about each table including ID, ARN, name, and * modification details.
* @public */ DataTableSummaryList: DataTableSummary[] | undefined; } /** * @public */ export interface ListDataTableValuesRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table whose values should be listed.
* @public */ DataTableId: string | undefined; /** *Optional list of specific record IDs to retrieve values for.
* @public */ RecordIds?: string[] | undefined; /** *Optional filter to retrieve values for records matching specific primary attribute criteria.
* @public */ PrimaryAttributeValues?: PrimaryAttributeValueFilter[] | 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 value summary.
* @public */ export interface DataTableValueSummary { /** *The summary's record ID.
* @public */ RecordId?: string | undefined; /** *The summary's attribute ID.
* @public */ AttributeId?: string | undefined; /** *The summary's primary values.
* @public */ PrimaryValues: PrimaryValueResponse[] | undefined; /** *The summary's attribute name.
* @public */ AttributeName: string | undefined; /** *The summary's value type.
* @public */ ValueType: DataTableAttributeValueType | undefined; /** *The summary's value.
* @public */ Value: string | undefined; /** *The summary's lock version.
* @public */ LockVersion?: DataTableLockVersion | undefined; /** *The summary's last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *The summary's last modified region.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListDataTableValuesResponse { /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *A list of data table values with their associated metadata, lock versions, and modification details.
* @public */ Values: DataTableValueSummary[] | undefined; } /** * @public */ export interface ListDefaultVocabulariesRequest { /** *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 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 maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Contains information about a default vocabulary.
* @public */ export interface DefaultVocabulary { /** *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 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 identifier of the custom vocabulary.
* @public */ VocabularyId: string | undefined; /** *A unique name of the custom vocabulary.
* @public */ VocabularyName: string | undefined; } /** * @public */ export interface ListDefaultVocabulariesResponse { /** *A list of default vocabularies.
* @public */ DefaultVocabularyList: DefaultVocabulary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListEntitySecurityProfilesRequest { /** *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; /** *Only supported type is AI_AGENT.
* @public */ EntityType: EntityType | undefined; /** *ARN of a Q in Connect AI Agent.
* @public */ EntityArn: string | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListEntitySecurityProfilesResponse { /** *List of Security Profile Object.
* @public */ SecurityProfiles?: SecurityProfileItem[] | 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; } /** * @public */ export interface ListEvaluationFormsRequest { /** *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 maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Summary information about an evaluation form.
* @public */ export interface EvaluationFormSummary { /** *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; /** *A title of the evaluation form.
* @public */ Title: string | undefined; /** *The timestamp for when the evaluation form was created.
* @public */ CreatedTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who created the evaluation form.
* @public */ CreatedBy: string | undefined; /** *The timestamp for when the evaluation form was last updated.
* @public */ LastModifiedTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
* @public */ LastModifiedBy: string | undefined; /** *The timestamp for when the evaluation form was last activated.
* @public */ LastActivatedTime?: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who last activated the evaluation form.
* @public */ LastActivatedBy?: string | undefined; /** *The version number of the latest evaluation form version.
* @public */ LatestVersion: number | undefined; /** *The version of the active evaluation form version.
* @public */ ActiveVersion?: number | undefined; } /** * @public */ export interface ListEvaluationFormsResponse { /** *Provides details about a list of evaluation forms belonging to an instance.
* @public */ EvaluationFormSummaryList: EvaluationFormSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListEvaluationFormVersionsRequest { /** *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 maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Summary information about an evaluation form.
* @public */ export interface EvaluationFormVersionSummary { /** *The Amazon Resource Name (ARN) for the evaluation form resource.
* @public */ EvaluationFormArn: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *A version of the evaluation form.
* @public */ EvaluationFormVersion: number | undefined; /** *The flag indicating whether the evaluation form is locked for changes.
* @public */ Locked: boolean | undefined; /** *The status of the evaluation form.
* @public */ Status: EvaluationFormVersionStatus | undefined; /** *The timestamp for when the evaluation form was created.
* @public */ CreatedTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who created the evaluation form.
* @public */ CreatedBy: string | undefined; /** *The timestamp for when the evaluation form was last updated.
* @public */ LastModifiedTime: Date | undefined; /** *The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
* @public */ LastModifiedBy: string | undefined; } /** * @public */ export interface ListEvaluationFormVersionsResponse { /** *Provides details about a list of evaluation forms belonging to an instance.
* @public */ EvaluationFormVersionSummaryList: EvaluationFormVersionSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListFlowAssociationsRequest { /** *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 valid resource type.
* @public */ ResourceType?: ListFlowAssociationResourceType | 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; } /** * @public */ export interface ListFlowAssociationsResponse { /** *Summary of flow associations.
* @public */ FlowAssociationSummaryList?: FlowAssociationSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListHoursOfOperationOverridesRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | 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; } /** * @public */ export interface ListHoursOfOperationOverridesResponse { /** *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; /** *Information about the hours of operation override.
* @public */ HoursOfOperationOverrideList?: HoursOfOperationOverride[] | 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 ListHoursOfOperationsRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about hours of operation for a contact center.
* @public */ export interface HoursOfOperationSummary { /** *The identifier of the hours of operation.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the hours of operation.
* @public */ Arn?: string | undefined; /** *The name of the hours of operation.
* @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; } /** * @public */ export interface ListHoursOfOperationsResponse { /** *Information about the hours of operation.
* @public */ HoursOfOperationSummaryList?: HoursOfOperationSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInstanceAttributesRequest { /** *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 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; } /** * @public */ export interface ListInstanceAttributesResponse { /** *The attribute types.
* @public */ Attributes?: Attribute[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInstancesRequest { /** *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 instance.
* @public */ export interface InstanceSummary { /** *The identifier of the instance.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the instance.
* @public */ Arn?: string | undefined; /** *The identity management type of the instance.
* @public */ IdentityManagementType?: DirectoryType | undefined; /** *The alias of the 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; /** *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; } /** * @public */ export interface ListInstancesResponse { /** *Information about the instances.
* @public */ InstanceSummaryList?: InstanceSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListInstanceStorageConfigsRequest { /** *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 valid resource type.
* @public */ ResourceType: InstanceStorageResourceType | 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; } /** * @public */ export interface ListInstanceStorageConfigsResponse { /** *A valid storage type.
* @public */ StorageConfigs?: InstanceStorageConfig[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListIntegrationAssociationsRequest { /** *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 integration type.
* @public */ IntegrationType?: IntegrationType | 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; /** *The Amazon Resource Name (ARN) of the integration.
* @public */ IntegrationArn?: string | undefined; } /** *Contains summary information about the associated AppIntegrations.
* @public */ export interface IntegrationAssociationSummary { /** *The identifier for the AppIntegration association.
* @public */ IntegrationAssociationId?: string | undefined; /** *The Amazon Resource Name (ARN) for the AppIntegration association.
* @public */ IntegrationAssociationArn?: 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; /** *The integration type.
* @public */ IntegrationType?: IntegrationType | undefined; /** *The Amazon Resource Name (ARN) for the AppIntegration.
* @public */ IntegrationArn?: string | undefined; /** *The URL for the external application.
* @public */ SourceApplicationUrl?: string | undefined; /** *The user-provided, friendly name for the external application.
* @public */ SourceApplicationName?: string | undefined; /** *The name of the source.
* @public */ SourceType?: SourceType | undefined; } /** * @public */ export interface ListIntegrationAssociationsResponse { /** *The associations.
* @public */ IntegrationAssociationSummaryList?: IntegrationAssociationSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListLambdaFunctionsRequest { /** *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 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; } /** * @public */ export interface ListLambdaFunctionsResponse { /** *The Lambdafunction ARNs associated with the specified instance.
* @public */ LambdaFunctions?: string[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListLexBotsRequest { /** *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 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. If no value is specified, the default is 10.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListLexBotsResponse { /** *The names and Amazon Web Services Regions of the Amazon Lex bots associated with the specified * instance.
* @public */ LexBots?: LexBot[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListNotificationsRequest { /** *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 token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page. Valid range is 1-100.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListNotificationsResponse { /** *The token for the next set of results. If present, there are more results available.
* @public */ NextToken?: string | undefined; /** *A list of notification summaries.
* @public */ NotificationSummaryList: Notification[] | undefined; } /** * @public */ export interface ListPhoneNumbersRequest { /** *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 phone number.
*We recommend using ListPhoneNumbersV2 to return phone number types. While ListPhoneNumbers returns number types
* UIFN, SHARED, THIRD_PARTY_TF, and THIRD_PARTY_DID, it
* incorrectly lists them as TOLL_FREE or DID.
The ISO country code.
* @public */ PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a phone number for a contact center.
* @public */ export interface PhoneNumberSummary { /** *The identifier of the phone number.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the phone number.
* @public */ Arn?: string | undefined; /** *The phone number.
* @public */ PhoneNumber?: string | undefined; /** *The type of phone number.
* @public */ PhoneNumberType?: PhoneNumberType | undefined; /** *The ISO country code.
* @public */ PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined; } /** * @public */ export interface ListPhoneNumbersResponse { /** *Information about the phone numbers.
* @public */ PhoneNumberSummaryList?: PhoneNumberSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListPhoneNumbersV2Request { /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both TargetArn and InstanceId input are not provided, this API lists
* numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
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. If both TargetArn and InstanceId are not provided, this API lists
* numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.
The maximum number of results to return per page.
* @public */ MaxResults?: number | 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 ISO country code.
* @public */ PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined; /** *The type of phone number.
* @public */ PhoneNumberTypes?: PhoneNumberType[] | undefined; /** *The prefix of the phone number. If provided, it must contain + as part of the country code.
Information about phone numbers that have been claimed to your Amazon Connect instance or traffic distribution group.
* @public */ export interface ListPhoneNumbersSummary { /** *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 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 description of the phone number.
* @public */ PhoneNumberDescription?: string | undefined; /** *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 ListPhoneNumbersV2Response { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.
* @public */ ListPhoneNumbersSummaryList?: ListPhoneNumbersSummary[] | undefined; } /** * @public */ export interface ListPredefinedAttributesRequest { /** *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 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; } /** *Summary of a predefined attribute.
* @public */ export interface PredefinedAttributeSummary { /** *The name of the predefined attribute.
* @public */ Name?: string | undefined; /** *Last modified time.
* @public */ LastModifiedTime?: Date | undefined; /** *Last modified region.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListPredefinedAttributesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Summary of the predefined attributes.
* @public */ PredefinedAttributeSummaryList?: PredefinedAttributeSummary[] | undefined; } /** * @public */ export interface ListPromptsRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains information about the prompt.
* @public */ export interface PromptSummary { /** *The identifier of the prompt.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the prompt.
* @public */ Arn?: string | undefined; /** *The name of the prompt.
* @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; } /** * @public */ export interface ListPromptsResponse { /** *Information about the prompts.
* @public */ PromptSummaryList?: PromptSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListQueueEmailAddressesRequest { /** *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 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; } /** *Summary information about an email address associated with a queue. Contains the essential details needed to identify and manage the email address routing configuration.
* @public */ export interface EmailAddressSummary { /** *The unique identifier of the email address associated with the queue.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the email address associated with the queue.
* @public */ Arn?: string | undefined; /** *Indicates whether this email address is configured as the default outbound email address for the queue. When set to true, this email address is used as the default sender for outbound email contacts from this queue.
* @public */ IsDefaultOutboundEmail?: boolean | undefined; } /** * @public */ export interface ListQueueEmailAddressesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *List of email address summary information for all email addresses associated with the queue. Each item contains the email address identifier, ARN, and configuration details.
* @public */ EmailAddressMetadataList?: EmailAddressSummary[] | 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 ListQueueQuickConnectsRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a quick connect.
* @public */ export interface QuickConnectSummary { /** *The identifier for the quick connect.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the quick connect.
* @public */ Arn?: string | undefined; /** *The name of the quick connect.
* @public */ Name?: string | undefined; /** *The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are * prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
* @public */ QuickConnectType?: QuickConnectType | 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 ListQueueQuickConnectsResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the quick connects.
* @public */ QuickConnectSummaryList?: QuickConnectSummary[] | 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 ListQueuesRequest { /** *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 queue.
* @public */ QueueTypes?: QueueType[] | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a queue.
* @public */ export interface QueueSummary { /** *The identifier of the queue.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the queue.
* @public */ Arn?: string | undefined; /** *The name of the queue.
* @public */ Name?: string | undefined; /** *The type of queue.
* @public */ QueueType?: QueueType | 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 ListQueuesResponse { /** *Information about the queues.
* @public */ QueueSummaryList?: QueueSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListQuickConnectsRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats.
* @public */ InstanceId: string | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; /** *The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are * prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
* @public */ QuickConnectTypes?: QuickConnectType[] | undefined; } /** * @public */ export interface ListQuickConnectsResponse { /** *Information about the quick connects.
* @public */ QuickConnectSummaryList?: QuickConnectSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListRealtimeContactAnalysisSegmentsV2Request { /** *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; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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 Contact Lens output type to be returned.
* @public */ OutputType: RealTimeContactAnalysisOutputType | undefined; /** *Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. * Each segment type has its own structure. Different channels may have different sets of supported segment * types.
* @public */ SegmentTypes: RealTimeContactAnalysisSegmentType[] | undefined; } /** *Object that describes attached file.
* @public */ export interface RealTimeContactAnalysisAttachment { /** *A case-sensitive name of the attachment being uploaded. Can be redacted.
* @public */ AttachmentName: string | undefined; /** *Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the * Amazon Connect Administrator Guide.
* @public */ ContentType?: string | undefined; /** *A unique identifier for the attachment.
* @public */ AttachmentId: string | undefined; /** *Status of the attachment.
* @public */ Status?: ArtifactStatus | undefined; } /** *Object describing time with which the segment is associated. It can have different representations of time. * Currently supported: absoluteTime
* @public */ export type RealTimeContactAnalysisTimeData = RealTimeContactAnalysisTimeData.AbsoluteTimeMember | RealTimeContactAnalysisTimeData.$UnknownMember; /** * @public */ export declare namespace RealTimeContactAnalysisTimeData { /** *Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
* @public */ interface AbsoluteTimeMember { AbsoluteTime: Date; $unknown?: never; } /** * @public */ interface $UnknownMember { AbsoluteTime?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorSegment containing list of attachments.
* @public */ export interface RealTimeContactAnalysisSegmentAttachments { /** *The identifier of the segment.
* @public */ Id: string | undefined; /** *The identifier of the participant.
* @public */ ParticipantId: string | undefined; /** *The role of the participant. For example, is it a customer, agent, or system.
* @public */ ParticipantRole: ParticipantRole | undefined; /** *The display name of the participant. Can be redacted.
* @public */ DisplayName?: string | undefined; /** *List of objects describing an individual attachment.
* @public */ Attachments: RealTimeContactAnalysisAttachment[] | undefined; /** *Field describing the time of the event. It can have different representations of time.
* @public */ Time: RealTimeContactAnalysisTimeData | undefined; } /** *Begin and end offsets for a part of text.
* @public */ export interface RealTimeContactAnalysisCharacterInterval { /** *The beginning of the character interval.
* @public */ BeginOffsetChar: number | undefined; /** *The end of the character interval.
* @public */ EndOffsetChar: number | undefined; } /** *Transcript representation containing Id and list of character intervals that are associated with analysis data.
* For example, this object within a RealTimeContactAnalysisPointOfInterest in
* Category.MatchedDetails would have character interval describing part of the text that matched
* category.
Transcript identifier. Matches the identifier from one of the TranscriptSegments.
* @public */ Id: string | undefined; /** *List of character intervals within transcript content/text.
* @public */ CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; } /** *The section of the contact transcript segment that category rule was detected.
* @public */ export interface RealTimeContactAnalysisPointOfInterest { /** *List of the transcript items (segments) that are associated with a given point of interest.
* @public */ TranscriptItems?: RealTimeContactAnalysisTranscriptItemWithCharacterOffsets[] | undefined; } /** *Provides information about the category rule that was matched.
* @public */ export interface RealTimeContactAnalysisCategoryDetails { /** *List of PointOfInterest - objects describing a single match of a rule.
* @public */ PointsOfInterest: RealTimeContactAnalysisPointOfInterest[] | undefined; } /** *The matched category rules.
* @public */ export interface RealTimeContactAnalysisSegmentCategories { /** *Map between the name of the matched rule and RealTimeContactAnalysisCategoryDetails.
* @public */ MatchedDetails: RecordSegment type describing a contact event.
* @public */ export interface RealTimeContactAnalysisSegmentEvent { /** *The identifier of the contact event.
* @public */ Id: string | undefined; /** *The identifier of the participant.
* @public */ ParticipantId?: string | undefined; /** *The role of the participant. For example, is it a customer, agent, or system.
* @public */ ParticipantRole?: ParticipantRole | undefined; /** *The display name of the participant. Can be redacted.
* @public */ DisplayName?: string | undefined; /** *Type of the event. For example, application/vnd.amazonaws.connect.event.participant.left.
Field describing the time of the event. It can have different representations of time.
* @public */ Time: RealTimeContactAnalysisTimeData | undefined; } /** *Transcript representation containing Id, Content and list of character intervals that are associated with * analysis data. For example, this object within an issue detected would describe both content that contains identified * issue and intervals where that content is taken from.
* @public */ export interface RealTimeContactAnalysisTranscriptItemWithContent { /** *Part of the transcript content that contains identified issue. Can be redacted
* @public */ Content?: string | undefined; /** *Transcript identifier. Matches the identifier from one of the TranscriptSegments.
* @public */ Id: string | undefined; /** *Begin and end offsets for a part of text.
* @public */ CharacterOffsets?: RealTimeContactAnalysisCharacterInterval | undefined; } /** *Potential issues that are detected based on an artificial intelligence analysis of each turn in the * conversation.
* @public */ export interface RealTimeContactAnalysisIssueDetected { /** *List of the transcript items (segments) that are associated with a given issue.
* @public */ TranscriptItems: RealTimeContactAnalysisTranscriptItemWithContent[] | undefined; } /** *Segment type containing a list of detected issues.
* @public */ export interface RealTimeContactAnalysisSegmentIssues { /** *List of the issues detected.
* @public */ IssuesDetected: RealTimeContactAnalysisIssueDetected[] | undefined; } /** *Information about the post-contact summary for a real-time contact segment.
* @public */ export interface RealTimeContactAnalysisSegmentPostContactSummary { /** *The content of the summary.
* @public */ Content?: string | undefined; /** *Whether the summary was successfully COMPLETED or FAILED to be generated.
* @public */ Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined; /** *If the summary failed to be generated, one of the following failure codes occurs:
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the
* participants in order to generate the summary.
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet
* system safety guidelines.
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
* INTERNAL_ERROR: Internal system error.
Object describing redaction applied to the segment.
* @public */ export interface RealTimeContactAnalysisTranscriptItemRedaction { /** *List of character intervals each describing a part of the text that was redacted. For
* OutputType.Raw, part of the original text that contains data that can be redacted. For
* OutputType.Redacted, part of the string with redaction tag.
The analyzed transcript segment.
* @public */ export interface RealTimeContactAnalysisSegmentTranscript { /** *The identifier of the transcript.
* @public */ Id: string | undefined; /** *The identifier of the participant.
* @public */ ParticipantId: string | undefined; /** *The role of the participant. For example, is it a customer, agent, or system.
* @public */ ParticipantRole: ParticipantRole | undefined; /** *The display name of the participant.
* @public */ DisplayName?: string | undefined; /** *The content of the transcript. Can be redacted.
* @public */ Content: string | undefined; /** *The type of content of the item. For example, text/plain.
Field describing the time of the event. It can have different representations of time.
* @public */ Time: RealTimeContactAnalysisTimeData | undefined; /** *Object describing redaction that was applied to the transcript. If transcript has the field it means part of the * transcript was redacted.
* @public */ Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined; /** *The sentiment detected for this piece of transcript.
* @public */ Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined; } /** *An analyzed segment for a real-time analysis session.
* @public */ export type RealtimeContactAnalysisSegment = RealtimeContactAnalysisSegment.AttachmentsMember | RealtimeContactAnalysisSegment.CategoriesMember | RealtimeContactAnalysisSegment.EventMember | RealtimeContactAnalysisSegment.IssuesMember | RealtimeContactAnalysisSegment.PostContactSummaryMember | RealtimeContactAnalysisSegment.TranscriptMember | RealtimeContactAnalysisSegment.$UnknownMember; /** * @public */ export declare namespace RealtimeContactAnalysisSegment { /** *The analyzed transcript segment.
* @public */ interface TranscriptMember { Transcript: RealTimeContactAnalysisSegmentTranscript; Categories?: never; Issues?: never; Event?: never; Attachments?: never; PostContactSummary?: never; $unknown?: never; } /** *The matched category rules.
* @public */ interface CategoriesMember { Transcript?: never; Categories: RealTimeContactAnalysisSegmentCategories; Issues?: never; Event?: never; Attachments?: never; PostContactSummary?: never; $unknown?: never; } /** *Segment type containing a list of detected issues.
* @public */ interface IssuesMember { Transcript?: never; Categories?: never; Issues: RealTimeContactAnalysisSegmentIssues; Event?: never; Attachments?: never; PostContactSummary?: never; $unknown?: never; } /** *Segment type describing a contact event.
* @public */ interface EventMember { Transcript?: never; Categories?: never; Issues?: never; Event: RealTimeContactAnalysisSegmentEvent; Attachments?: never; PostContactSummary?: never; $unknown?: never; } /** *The analyzed attachments.
* @public */ interface AttachmentsMember { Transcript?: never; Categories?: never; Issues?: never; Event?: never; Attachments: RealTimeContactAnalysisSegmentAttachments; PostContactSummary?: never; $unknown?: never; } /** *Information about the post-contact summary.
* @public */ interface PostContactSummaryMember { Transcript?: never; Categories?: never; Issues?: never; Event?: never; Attachments?: never; PostContactSummary: RealTimeContactAnalysisSegmentPostContactSummary; $unknown?: never; } /** * @public */ interface $UnknownMember { Transcript?: never; Categories?: never; Issues?: never; Event?: never; Attachments?: never; PostContactSummary?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe channel of the contact.
*Only CHAT is supported. This API does not support VOICE. If you attempt to use it for
* the VOICE channel, an InvalidRequestException error occurs.
Status of real-time contact analysis.
* @public */ Status: RealTimeContactAnalysisStatus | undefined; /** *An analyzed transcript or category.
* @public */ Segments: RealtimeContactAnalysisSegment[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListRoutingProfileManualAssignmentQueuesRequest { /** *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 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 summary information about a routing profile manual assignment queue.
* @public */ export interface RoutingProfileManualAssignmentQueueConfigSummary { /** *The identifier for the queue.
* @public */ QueueId: string | undefined; /** *The Amazon Resource Name (ARN) of the queue.
* @public */ QueueArn: string | undefined; /** *The name of the queue.
* @public */ QueueName: string | undefined; /** *The channels this queue supports. Valid Values: CHAT | TASK | EMAIL
*VOICE is not supported. The information shown below is incorrect. We're working to correct it.
*If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the manual assignment queues associated with the routing profile.
* @public */ RoutingProfileManualAssignmentQueueConfigSummaryList?: RoutingProfileManualAssignmentQueueConfigSummary[] | 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 ListRoutingProfileQueuesRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a routing profile queue.
* @public */ export interface RoutingProfileQueueConfigSummary { /** *The identifier for the queue.
* @public */ QueueId: string | undefined; /** *The Amazon Resource Name (ARN) of the queue.
* @public */ QueueArn: string | undefined; /** *The name of the queue.
* @public */ QueueName: string | undefined; /** *The order in which contacts are to be handled for the queue. For more information, see Queues: priority and * delay.
* @public */ Priority: number | undefined; /** *The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For * more information, see Queues: priority and delay in the * Amazon Connect Administrator Guide.
* @public */ Delay: number | undefined; /** *The channels this queue supports.
* @public */ Channel: Channel | undefined; } /** * @public */ export interface ListRoutingProfileQueuesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the routing profiles.
* @public */ RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[] | 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 ListRoutingProfilesRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a routing profile.
* @public */ export interface RoutingProfileSummary { /** *The identifier of the routing profile.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the routing profile.
* @public */ Arn?: string | undefined; /** *The name of the routing profile.
* @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; } /** * @public */ export interface ListRoutingProfilesResponse { /** *Information about the routing profiles.
* @public */ RoutingProfileSummaryList?: RoutingProfileSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListRulesRequest { /** *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 publish status of the rule.
* @public */ PublishStatus?: RulePublishStatus | undefined; /** *The name of the event source.
* @public */ EventSourceName?: EventSourceName | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *A list of ActionTypes associated with a 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 name of the event source.
* @public */ EventSourceName: EventSourceName | undefined; /** *The publish status of the rule.
* @public */ PublishStatus: RulePublishStatus | undefined; /** *A list of ActionTypes associated with a rule.
* @public */ ActionSummaries: ActionSummary[] | undefined; /** *The timestamp for when the rule was created.
* @public */ CreatedTime: Date | undefined; /** *The timestamp for when the rule was last updated.
* @public */ LastUpdatedTime: Date | undefined; } /** * @public */ export interface ListRulesResponse { /** *Summary information about a rule.
* @public */ RuleSummaryList: RuleSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListSecurityKeysRequest { /** *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 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; } /** *Configuration information of the security key.
* @public */ export interface SecurityKey { /** *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ AssociationId?: string | undefined; /** *The key of the security key.
* @public */ Key?: string | undefined; /** *When the security key was created.
* @public */ CreationTime?: Date | undefined; } /** * @public */ export interface ListSecurityKeysResponse { /** *The security keys.
* @public */ SecurityKeys?: SecurityKey[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListSecurityProfileApplicationsRequest { /** *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; /** *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; } /** * @public */ export interface ListSecurityProfileApplicationsResponse { /** *A list of the third-party application's metadata.
* @public */ Applications?: Application[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: 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; } /** * @public */ export interface ListSecurityProfileFlowModulesRequest { /** *The identifier for the security profile.
* @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; /** *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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListSecurityProfileFlowModulesResponse { /** *A list of Flow Modules an AI Agent can invoke as a tool.
* @public */ AllowedFlowModules?: FlowModule[] | 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 time the flow module was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The Region that flow module was last modified in.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListSecurityProfilePermissionsRequest { /** *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; /** *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; } /** * @public */ export interface ListSecurityProfilePermissionsResponse { /** *The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile * permissions.
* @public */ Permissions?: string[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: 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; } /** * @public */ export interface ListSecurityProfilesRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains information about a security profile.
* @public */ export interface SecurityProfileSummary { /** *The identifier of the security profile.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the security profile.
* @public */ Arn?: string | undefined; /** *The name of the security profile.
* @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; } /** * @public */ export interface ListSecurityProfilesResponse { /** *Information about the security profiles.
* @public */ SecurityProfileSummaryList?: SecurityProfileSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have * an ARN. To locate the ARN for an instance, for example, see Find your Amazon Connect instance ID/ARN.
* @public */ resourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *Information about the tags.
* @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; /** *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.
*It is not expected that you set this because the value returned in the previous response is always null.
*The maximum number of results to return per page.
*It is not expected that you set this.
*Marks a template as ACTIVE or INACTIVE for a task to refer to it.
* Tasks can only be created from ACTIVE templates.
* If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
The name of the task template.
* @public */ Name?: string | undefined; } /** *Contains summary information about the task template.
* @public */ export interface TaskTemplateMetadata { /** *A unique identifier for the task template.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the task template.
* @public */ Arn?: string | undefined; /** *The name of the task template.
* @public */ Name?: string | undefined; /** *The description of the task template.
* @public */ Description?: string | undefined; /** *Marks a template as ACTIVE or INACTIVE for a task to refer to it.
* Tasks can only be created from ACTIVE templates.
* If a template is marked as INACTIVE, then a task that refers to this template cannot be created.
The timestamp when the task template was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The timestamp when the task template was created.
* @public */ CreatedTime?: Date | undefined; } /** * @public */ export interface ListTaskTemplatesResponse { /** *Provides details about a list of task templates belonging to an instance.
* @public */ TaskTemplates?: TaskTemplateMetadata[] | undefined; /** *If there are additional results, this is the token for the next set of results.
*This is always returned as a null in the response.
*The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case.
* @public */ TestCaseId: string | undefined; /** *The identifier of the test case execution.
* @public */ TestCaseExecutionId: string | undefined; /** *Filter execution records by status.
* @public */ Status?: TestCaseExecutionStatus | 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; } /** *Contains information about a test case execution record.
* @public */ export interface ExecutionRecord { /** *The identifier of the execution record.
* @public */ ObservationId?: string | undefined; /** *The status of the action execution.
* @public */ Status?: ExecutionRecordStatus | undefined; /** *The timestamp when the action was executed.
* @public */ Timestamp?: Date | undefined; /** *The details of the executed record.
* @public */ Record?: string | undefined; } /** * @public */ export interface ListTestCaseExecutionRecordsResponse { /** *An array of test case execution record objects.
* @public */ ExecutionRecords?: ExecutionRecord[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTestCaseExecutionsRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *Filter executions by test case identifier.
* @public */ TestCaseId?: string | undefined; /** *Filter executions by test case name.
* @public */ TestCaseName?: string | undefined; /** *Filter executions that started after this time.
* @public */ StartTime?: number | undefined; /** *Filter executions that started before this time.
* @public */ EndTime?: number | undefined; /** *Filter executions by status.
* @public */ Status?: TestCaseExecutionStatus | 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; } /** *Contains information about a test case execution.
* @public */ export interface TestCaseExecution { /** *The timestamp when the test case execution started.
* @public */ StartTime?: Date | undefined; /** *The timestamp when the test case execution ended.
* @public */ EndTime?: Date | undefined; /** *The identifier of the test case execution.
* @public */ TestCaseExecutionId?: string | undefined; /** *The identifier of the test case.
* @public */ TestCaseId?: string | undefined; /** *The status of the test case execution.
* @public */ TestCaseExecutionStatus?: TestCaseExecutionStatus | undefined; /** *The tags used to organize, track, or control access for this resource.
* @public */ Tags?: RecordAn array of test case execution summary objects.
* @public */ TestCaseExecutions?: TestCaseExecution[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTestCasesRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | 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; } /** *Contains summary information about a test case.
* @public */ export interface TestCaseSummary { /** *The identifier of the test case.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the test case.
* @public */ Arn?: string | undefined; /** *The name of the test case.
* @public */ Name?: string | undefined; /** *The status of the test case.
* @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; } /** * @public */ export interface ListTestCasesResponse { /** *Information about the tests.
* @public */ TestCaseSummaryList?: TestCaseSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTrafficDistributionGroupsRequest { /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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 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; } /** *Information about traffic distribution groups.
* @public */ export interface TrafficDistributionGroupSummary { /** *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 Amazon Resource Name (ARN) of the traffic distribution group.
* @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 UpdateTrafficDistributionGroup
* operation is still in progress and has not yet completed.
Whether 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.
If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of traffic distribution groups.
* @public */ TrafficDistributionGroupSummaryList?: TrafficDistributionGroupSummary[] | undefined; } /** * @public */ export interface ListTrafficDistributionGroupUsersRequest { /** *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; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Summary information about a traffic distribution group user.
* @public */ export interface TrafficDistributionGroupUserSummary { /** *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ UserId?: string | undefined; } /** * @public */ export interface ListTrafficDistributionGroupUsersResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of traffic distribution group users.
* @public */ TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[] | undefined; } /** *Provides summary information about the use cases for the specified integration association.
* @public */ export interface ListUseCasesRequest { /** *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 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 * use * case.
* @public */ export interface UseCase { /** *The identifier for the use case.
* @public */ UseCaseId?: string | undefined; /** *The Amazon Resource Name (ARN) for the use case.
* @public */ UseCaseArn?: string | undefined; /** *The type of use case to associate to the integration association. Each integration association can have only one * of each use case type.
* @public */ UseCaseType?: UseCaseType | undefined; } /** * @public */ export interface ListUseCasesResponse { /** *The use cases.
* @public */ UseCaseSummaryList?: UseCase[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUserHierarchyGroupsRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListUserHierarchyGroupsResponse { /** *Information about the hierarchy groups.
* @public */ UserHierarchyGroupSummaryList?: HierarchyGroupSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUserNotificationsRequest { /** *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 token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return per page. Valid range is 1-1000.
* @public */ MaxResults?: number | undefined; /** *The identifier of the user.
* @public */ UserId: string | undefined; } /** *Summary information about a notification for a specific user, including the user's read status.
* @public */ export interface UserNotificationSummary { /** *The unique identifier for the notification.
* @public */ NotificationId?: string | undefined; /** *The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.
* @public */ NotificationStatus?: NotificationStatus | undefined; /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId?: string | undefined; /** *The identifier of the recipient user.
* @public */ RecipientId?: string | undefined; /** *The localized content of the notification.
* @public */ Content?: PartialThe priority level of the notification.
* @public */ Priority?: NotificationPriority | undefined; /** *The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.
* @public */ Source?: NotificationSource | undefined; /** *The timestamp when the notification was created.
* @public */ CreatedAt?: Date | undefined; /** *The timestamp when the notification expires.
* @public */ ExpiresAt?: Date | undefined; } /** * @public */ export interface ListUserNotificationsResponse { /** *A list of notifications sent to the specified user.
* @public */ UserNotifications?: UserNotificationSummary[] | undefined; /** *The token for the next set of results. If present, there are more results available.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListUserProficienciesRequest { /** *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 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; } /** * @public */ export interface ListUserProficienciesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *Information about the user proficiencies.
* @public */ UserProficiencyList?: UserProficiency[] | undefined; /** *The last time that the user's proficiencies are were modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The region in which a user's proficiencies were last modified.
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface ListUsersRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *Contains summary information about a user.
* @public */ export interface UserSummary { /** *The identifier of the user account.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the user account.
* @public */ Arn?: string | undefined; /** *The Amazon Connect user name of the user account.
* @public */ Username?: 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; } /** * @public */ export interface ListUsersResponse { /** *Information about the users.
* @public */ UserSummaryList?: UserSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListViewsRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the * instance.
* @public */ InstanceId: string | undefined; /** *The type of the view.
* @public */ Type?: ViewType | 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *A summary of a view's metadata.
* @public */ export interface ViewSummary { /** *The identifier of the view.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the view.
* @public */ Arn?: string | undefined; /** *The name of the view.
* @public */ Name?: string | undefined; /** *The type of the view.
* @public */ Type?: ViewType | undefined; /** *Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content.
The description of the view.
* @public */ Description?: string | undefined; } /** * @public */ export interface ListViewsResponse { /** *A list of view summaries.
* @public */ ViewsSummaryList?: ViewSummary[] | 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; } /** * @public */ export interface ListViewVersionsRequest { /** *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 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. The default MaxResult size is 100.
* @public */ MaxResults?: number | undefined; } /** *A summary of a view version's metadata.
* @public */ export interface ViewVersionSummary { /** *The identifier of the view version.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the view version.
* @public */ Arn?: string | undefined; /** *The description of the view version.
* @public */ Description?: string | undefined; /** *The name of the view version.
* @public */ Name?: string | undefined; /** *The type of the view version.
* @public */ Type?: ViewType | undefined; /** *The sequentially incremented version of the view version.
* @public */ Version?: number | undefined; /** *The description of the view version.
* @public */ VersionDescription?: string | undefined; } /** * @public */ export interface ListViewVersionsResponse { /** *A list of view version summaries.
* @public */ ViewVersionSummaryList?: ViewVersionSummary[] | 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; } /** * @public */ export interface ListWorkspaceMediaRequest { /** *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 media asset used in a workspace.
* @public */ export interface MediaItem { /** *The type of media. Valid values are: IMAGE_LOGO_FAVICON and
* IMAGE_LOGO_HORIZONTAL.
The source URL or data for the media asset.
* @public */ Source?: string | undefined; } /** * @public */ export interface ListWorkspaceMediaResponse { /** *A list of media assets for the workspace.
* @public */ Media?: MediaItem[] | undefined; } /** * @public */ export interface ListWorkspacePagesRequest { /** *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 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 information about a page configuration in a workspace, including the view assigned to the page.
* @public */ export interface WorkspacePage { /** *The Amazon Resource Name (ARN) of the view associated with this page.
* @public */ ResourceArn?: string | undefined; /** *The page identifier. System pages include HOME and AGENT_EXPERIENCE.
The URL-friendly identifier for the page.
* @public */ Slug?: string | undefined; /** *A JSON string containing input parameters passed to the view when the page is rendered.
* @public */ InputData?: string | undefined; } /** * @public */ export interface ListWorkspacePagesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of page configurations in the workspace.
* @public */ WorkspacePageList: WorkspacePage[] | undefined; } /** * @public */ export interface ListWorkspacesRequest { /** *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 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 summary information about a workspace.
* @public */ export interface WorkspaceSummary { /** *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 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; } /** * @public */ export interface ListWorkspacesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A summary list of workspaces.
* @public */ WorkspaceSummaryList: WorkspaceSummary[] | undefined; } /** * @public */ export interface MonitorContactRequest { /** *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; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to * escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.
* @public */ AllowedMonitorCapabilities?: MonitorCapability[] | 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 MonitorContactResponse { /** *The identifier of the contact.
* @public */ ContactId?: string | undefined; /** *The ARN of the contact.
* @public */ ContactArn?: string | undefined; } /** * @public */ export interface PauseContactRequest { /** *The identifier of the contact.
* @public */ ContactId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
* instance.
The identifier of the flow.
* @public */ ContactFlowId?: string | undefined; } /** * @public */ export interface PauseContactResponse { } /** * @public */ export interface PutUserStatusRequest { /** *The identifier 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; /** *The identifier of the agent status.
* @public */ AgentStatusId: string | undefined; } /** * @public */ export interface PutUserStatusResponse { } /** * @public */ export interface ReleasePhoneNumberRequest { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId: 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 ReplicateInstanceRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You can provide the InstanceId, or the entire ARN.
The Amazon Web Services Region where to replicate the Amazon Connect instance.
* @public */ ReplicaRegion: 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; /** *The alias for the replicated instance. The ReplicaAlias must be unique.
The identifier of the replicated instance. You can find the instanceId in the ARN of the instance.
* The replicated instance has the same identifier as the instance it was replicated from.
The Amazon Resource Name (ARN) of the replicated instance.
* @public */ Arn?: string | undefined; } /** * @public */ export interface ResumeContactRequest { /** *The identifier of the contact.
* @public */ ContactId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the
* instance.
The identifier of the flow.
* @public */ ContactFlowId?: string | undefined; } /** * @public */ export interface ResumeContactResponse { } /** * @public */ export interface ResumeContactRecordingRequest { /** *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; /** *The identifier of the contact. This is the identifier of the contact associated with the first interaction with * the contact center.
* @public */ InitialContactId: string | undefined; /** *The type of recording being operated on.
* @public */ ContactRecordingType?: ContactRecordingType | undefined; } /** * @public */ export interface ResumeContactRecordingResponse { } /** * @public */ export interface SearchAgentStatusesResponse { /** *The search criteria to be used to return agent statuses.
* @public */ AgentStatuses?: AgentStatus[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of agent statuses which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** * @public */ export interface SearchAvailablePhoneNumbersRequest { /** *The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.
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. You must enter InstanceId or TargetArn.
The ISO country code.
* @public */ PhoneNumberCountryCode: PhoneNumberCountryCode | undefined; /** *The type of phone number.
* @public */ PhoneNumberType: PhoneNumberType | undefined; /** *The prefix of the phone number. If provided, it must contain + as part of the country code.
The maximum number of results to return per page.
* @public */ MaxResults?: number | 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; } /** *Information about available phone numbers.
* @public */ export interface AvailableNumberSummary { /** *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; } /** * @public */ export interface SearchAvailablePhoneNumbersResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
* @public */ AvailableNumbersList?: AvailableNumberSummary[] | undefined; } /** *A boolean search condition for Search APIs.
* @public */ export interface BooleanCondition { /** *A name of the property to be searched.
* @public */ FieldName?: string | undefined; /** *Boolean property comparison type.
* @public */ ComparisonType?: BooleanComparisonType | undefined; } /** *A datetime search condition for Search APIs.
* @public */ export interface DateTimeCondition { /** *A name of the datetime property to be searched
* @public */ FieldName?: string | undefined; /** *A minimum value of the property.
* @public */ MinValue?: string | undefined; /** *A maximum value of the property.
* @public */ MaxValue?: string | undefined; /** *Datetime property comparison type.
* @public */ ComparisonType?: DateTimeComparisonType | undefined; } /** *A decimal search condition for Search APIs.
* @public */ export interface DecimalCondition { /** *A name of the decimal property to be searched.
* @public */ FieldName?: string | undefined; /** *A minimum value of the decimal property.
* @public */ MinValue?: number | undefined; /** *A maximum value of the decimal property.
* @public */ MaxValue?: number | undefined; /** *The type of comparison to be made when evaluating the decimal condition.
* @public */ ComparisonType?: DecimalComparisonType | undefined; } /** *A leaf node condition which can be used to specify a numeric condition.
*The currently supported value for FieldName is limit.
The name of the field in the number condition.
* @public */ FieldName?: string | undefined; /** *The minValue to be used while evaluating the number condition.
* @public */ MinValue?: number | undefined; /** *The maxValue to be used while evaluating the number condition.
* @public */ MaxValue?: number | undefined; /** *The type of comparison to be made when evaluating the number condition.
* @public */ ComparisonType?: NumberComparisonType | undefined; } /** *Filters to be applied to search results.
* @public */ export interface EvaluationSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
Metadata information about an evaluation search.
* @public */ export interface EvaluationSearchMetadata { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: string | undefined; /** *The Amazon Resource Name (ARN) of the person who evaluated the contact.
* @public */ EvaluatorArn: string | undefined; /** *The unique ID of the agent who handled the contact.
* @public */ ContactAgentId?: string | undefined; /** *The calibration session ID that this evaluation belongs to.
* @public */ CalibrationSessionId?: string | undefined; /** *The total evaluation score expressed as a percentage.
* @public */ ScorePercentage?: number | undefined; /** *The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this * flag is true.
* @public */ ScoreAutomaticFail?: boolean | undefined; /** *The flag to mark the item as not applicable for scoring.
* @public */ ScoreNotApplicable?: boolean | undefined; /** *Whether auto-evaluation is enabled.
* @public */ AutoEvaluationEnabled?: boolean | undefined; /** *The status of the contact auto evaluation.
* @public */ AutoEvaluationStatus?: AutoEvaluationStatus | undefined; /** *When the evaluation was acknowledged by the agent.
* @public */ AcknowledgedTime?: Date | undefined; /** *The agent who acknowledged the evaluation.
* @public */ AcknowledgedBy?: string | undefined; /** *The comment from the agent when they acknowledged the evaluation.
* @public */ AcknowledgerComment?: string | undefined; /** *Identifier of the sampling job.
* @public */ SamplingJobId?: string | undefined; /** *Identifier for the review.
* @public */ ReviewId?: string | undefined; /** *Role of a contact participant in the evaluation.
* @public */ ContactParticipantRole?: ContactParticipantRole | undefined; /** *Identifier for a contact participant in the evaluation.
* @public */ ContactParticipantId?: string | undefined; } /** *Summary of evaluation obtained from the search operation.
* @public */ export interface EvaluationSearchSummary { /** *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; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId?: string | undefined; /** *A version of the evaluation form.
* @public */ EvaluationFormVersion: number | undefined; /** *Title of the evaluation form.
* @public */ EvaluationFormTitle?: string | undefined; /** *Summary information about the evaluation search.
* @public */ Metadata: EvaluationSearchMetadata | undefined; /** *The status of the evaluation.
* @public */ Status: EvaluationStatus | undefined; /** *Type of the evaluation.
* @public */ EvaluationType?: EvaluationType | undefined; /** *The date and time when the evaluation was created, in UTC time.
* @public */ CreatedTime: Date | undefined; /** *The date and time when the evaluation was modified last time, in UTC time.
* @public */ LastModifiedTime: Date | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordContains information about contact evaluations.
* @public */ EvaluationSearchSummaryList?: EvaluationSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of contact evaluations that matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
A list of conditions which would be applied together with an OR condition.
A list of conditions which would be applied together with an AND condition.
A leaf node condition which can be used to specify a tag condition.
* @public */ TagCondition?: TagCondition | undefined; } /** *The search criteria to be used to return flow modules.
* @public */ export interface ContactFlowModuleSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
The search criteria to be used to return flow modules.
* @public */ ContactFlowModules?: ContactFlowModule[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of flows which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *The contact flow type condition.
* @public */ export interface ContactFlowTypeCondition { /** *Contact flow type of the contact flow type condition.
* @public */ ContactFlowType?: ContactFlowType | undefined; } /** *A list of conditions which would be applied together with an AND condition.
* @public */ export interface ContactFlowAttributeAndCondition { /** *Tag-based conditions for contact flow filtering.
* @public */ TagConditions?: TagCondition[] | undefined; /** *Contact flow type condition.
* @public */ ContactFlowTypeCondition?: ContactFlowTypeCondition | undefined; } /** *Filter for contact flow attributes with multiple condition types.
* @public */ export interface ContactFlowAttributeFilter { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: ContactFlowAttributeAndCondition[] | undefined; /** *A list of conditions which would be applied together with a AND condition.
* @public */ AndCondition?: ContactFlowAttributeAndCondition | undefined; /** *A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.
*
Contact flow type condition within attribute filter.
* @public */ ContactFlowTypeCondition?: ContactFlowTypeCondition | undefined; } /** *Filters to be applied to search results.
* @public */ export interface ContactFlowSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Flow attribute filter for contact flow search operations.
* @public */ FlowAttributeFilter?: ContactFlowAttributeFilter | undefined; } /** * @public */ export interface SearchContactFlowsResponse { /** *Information about the flows.
* @public */ ContactFlows?: ContactFlow[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of flows which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *A structure of time range that you want to search results.
* @public */ export interface SearchContactsTimeRange { /** *The type of timestamp to search.
* @public */ Type: SearchContactsTimeRangeType | undefined; /** *The start time of the time range.
* @public */ StartTime: Date | undefined; /** *The end time of the time range.
* @public */ EndTime: Date | undefined; } /** *The timestamp condition indicating which contact timestamp should be used and how it should be filtered. It is * not an actual timestamp value.
* @public */ export interface SearchContactsTimestampCondition { /** *Type of the timestamps to use for the filter.
* @public */ Type: SearchContactsTimeRangeType | undefined; /** *Condition of the timestamp on the contact.
* @public */ ConditionType: SearchContactsTimeRangeConditionType | undefined; } /** *The criteria of the time range to additionally filter on.
* @public */ export interface SearchContactsAdditionalTimeRangeCriteria { /** *A structure of time range that you want to search results.
* @public */ TimeRange?: SearchContactsTimeRange | undefined; /** *List of the timestamp conditions.
* @public */ TimestampCondition?: SearchContactsTimestampCondition | undefined; } /** *Time range that you additionally want to filter on.
*This is different from the SearchContactsTimeRange data * type.
*List of criteria of the time range to additionally filter on.
* @public */ Criteria: SearchContactsAdditionalTimeRangeCriteria[] | undefined; /** *The match type combining multiple time range filters.
* @public */ MatchType: SearchContactsMatchType | undefined; } /** *A structure that defines search criteria base on words or phrases, participants in the Contact Lens * conversational analytics transcript.
* @public */ export interface TranscriptCriteria { /** *The participant role in a transcript
* @public */ ParticipantRole: ParticipantRole | undefined; /** *The words or phrases used to search within a transcript.
* @public */ SearchText: string[] | undefined; /** *The match type combining search criteria using multiple search texts in a transcript criteria.
* @public */ MatchType: SearchContactsMatchType | undefined; } /** *A structure that defines search criteria and matching logic to search for contacts by matching text with * transcripts analyzed by Amazon Connect Contact Lens.
* @public */ export interface Transcript { /** *The list of search criteria based on Contact Lens conversational analytics transcript.
* @public */ Criteria: TranscriptCriteria[] | undefined; /** *The match type combining search criteria using multiple transcript criteria.
* @public */ MatchType?: SearchContactsMatchType | undefined; } /** *A structure that defines search criteria for contacts using analysis outputs from Amazon Connect Contact * Lens.
* @public */ export interface ContactAnalysis { /** *Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
* @public */ Transcript?: Transcript | undefined; } /** *The search criteria based on the contact name
* @public */ export interface NameCriteria { /** *The words or phrases used to match the contact name.
* @public */ SearchText: string[] | undefined; /** *The match type combining name search criteria using multiple search texts in a name criteria.
* @public */ MatchType: SearchContactsMatchType | undefined; } /** *The agent criteria to search for preferred agents on the routing criteria.
* @public */ export interface SearchableAgentCriteriaStep { /** *The identifiers of agents used in preferred agents matching.
* @public */ AgentIds?: string[] | undefined; /** *The match type combining multiple agent criteria steps.
* @public */ MatchType?: SearchContactsMatchType | undefined; } /** *Routing criteria of the contact to match on.
* @public */ export interface SearchableRoutingCriteriaStep { /** *Agent matching the routing step of the routing criteria
* @public */ AgentCriteria?: SearchableAgentCriteriaStep | undefined; } /** *Routing criteria of the contact to match on.
* @public */ export interface SearchableRoutingCriteria { /** *The list of Routing criteria steps of the contact routing.
* @public */ Steps?: SearchableRoutingCriteriaStep[] | undefined; } /** *The search criteria based on user-defined contact attribute key and values to search on.
* @public */ export interface SearchableContactAttributesCriteria { /** *The key containing a searchable user-defined contact attribute.
* @public */ Key: string | undefined; /** *The list of values to search for within a user-defined contact attribute.
* @public */ Values: string[] | undefined; } /** *A structure that defines search criteria based on user-defined contact attributes that are configured for * contact search.
* @public */ export interface SearchableContactAttributes { /** *The list of criteria based on user-defined contact attributes that are configured for contact search.
* @public */ Criteria: SearchableContactAttributesCriteria[] | undefined; /** *The match type combining search criteria using multiple searchable contact attributes.
* @public */ MatchType?: SearchContactsMatchType | undefined; } /** *The search criteria based on searchable segment attribute key and values to search on.
* @public */ export interface SearchableSegmentAttributesCriteria { /** *The key containing a searchable segment attribute.
* @public */ Key: string | undefined; /** *The list of values to search for within a searchable segment attribute.
* @public */ Values: string[] | undefined; } /** *The search criteria based on searchable segment attributes of a contact
* @public */ export interface SearchableSegmentAttributes { /** *The list of criteria based on searchable segment attributes.
* @public */ Criteria: SearchableSegmentAttributesCriteria[] | undefined; /** *The match type combining search criteria using multiple searchable segment attributes.
* @public */ MatchType?: SearchContactsMatchType | undefined; } /** *A structure of search criteria to be used to return contacts.
* @public */ export interface SearchCriteria { /** *Name of the contact.
* @public */ Name?: NameCriteria | undefined; /** *The identifiers of agents who handled the contacts.
* @public */ AgentIds?: string[] | undefined; /** *The agent hierarchy groups of the agent at the time of handling the contact.
* @public */ AgentHierarchyGroups?: AgentHierarchyGroups | undefined; /** *The list of channels associated with contacts.
* @public */ Channels?: Channel[] | undefined; /** *Search criteria based on analysis outputs from Amazon Connect Contact Lens.
* @public */ ContactAnalysis?: ContactAnalysis | undefined; /** *The list of initiation methods associated with contacts.
* @public */ InitiationMethods?: ContactInitiationMethod[] | undefined; /** *The list of queue IDs associated with contacts.
* @public */ QueueIds?: string[] | undefined; /** *Routing criteria for the contact.
* @public */ RoutingCriteria?: SearchableRoutingCriteria | undefined; /** *Additional TimeRange used to filter contacts.
* @public */ AdditionalTimeRange?: SearchContactsAdditionalTimeRange | undefined; /** *The search criteria based on user-defined contact attributes that have been configured for contact search. For * more information, see Search by custom contact attributes in the Amazon Connect Administrator * Guide.
*To use SearchableContactAttributes in a search request, the GetContactAttributes
* action is required to perform an API request. For more information, see https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissionsActions
* defined by Amazon Connect.
The search criteria based on searchable segment attributes of a contact.
* @public */ SearchableSegmentAttributes?: SearchableSegmentAttributes | undefined; /** *The list of active regions for contacts in ACGR instances.
* @public */ ActiveRegions?: string[] | undefined; /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
A structure that defines the field name to sort by and a sort order.
* @public */ export interface Sort { /** *The name of the field on which to sort.
* @public */ FieldName: SortableFieldName | undefined; /** *An ascending or descending sort.
* @public */ Order: SortOrder | undefined; } /** * @public */ export interface SearchContactsRequest { /** *The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of * the instance.
* @public */ InstanceId: string | undefined; /** *Time range that you want to search results.
* @public */ TimeRange: SearchContactsTimeRange | undefined; /** *The search criteria to be used to return contacts.
* @public */ SearchCriteria?: SearchCriteria | undefined; /** *The maximum number of results to return per page.
* @public */ MaxResults?: number | 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; /** *Specifies a field to sort by and a sort order.
* @public */ Sort?: Sort | undefined; } /** *Information about the agent who accepted the contact.
* @public */ export interface ContactSearchSummaryAgentInfo { /** *The identifier of the agent who accepted the contact.
* @public */ Id?: string | undefined; /** *The timestamp when the contact was connected to the agent.
* @public */ ConnectedToAgentTimestamp?: Date | undefined; } /** *If this contact was queued, this contains information about the queue.
* @public */ export interface ContactSearchSummaryQueueInfo { /** *The unique identifier for the queue.
* @public */ Id?: string | undefined; /** *The timestamp when the contact was added to the queue.
* @public */ EnqueueTimestamp?: Date | undefined; } /** *A data table search filter.
* @public */ export interface DataTableSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
An array of data tables matching the search criteria with the same structure as DescribeTable except Version, * VersionDescription, and LockVersion are omitted.
* @public */ DataTables?: DataTable[] | undefined; /** *Specify the pagination token from a previous request to retrieve the next page of results.
* @public */ NextToken?: string | undefined; /** *The approximate number of data tables that matched the search criteria.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface EmailAddressSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Contains information about an email address for a contact center.
* @public */ export interface EmailAddressMetadata { /** *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 description of the email address.
* @public */ Description?: string | undefined; /** *The display name of email address.
* @public */ DisplayName?: string | undefined; /** *A list of alias configurations for this email address, showing which email addresses forward to this primary * address. Each configuration contains the email address ID of an alias that forwards emails to this address.
* @public */ AliasConfigurations?: AliasConfiguration[] | undefined; } /** * @public */ export interface SearchEmailAddressesResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *List of email addresses matching SearchFilter and SearchCriteria
* @public */ EmailAddresses?: EmailAddressMetadata[] | undefined; /** *The total number of email addresses which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface EvaluationFormSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The inner list specifies conditions that need to be applied with AND operator.
Information about the returned evaluation forms.
* @public */ export interface EvaluationFormSearchSummary { /** *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 title of the evaluation form.
* @public */ Title: string | undefined; /** *The status of the evaluation form.
* @public */ Status: EvaluationFormVersionStatus | undefined; /** *The description of the evaluation form.
* @public */ Description?: string | undefined; /** *When the evaluation form was created.
* @public */ CreatedTime: Date | undefined; /** *Who created the evaluation form.
* @public */ CreatedBy: string | undefined; /** *When the evaluation form was last changed.
* @public */ LastModifiedTime: Date | undefined; /** *Who changed the evaluation form.
* @public */ LastModifiedBy: string | undefined; /** *When the evaluation format was last activated.
* @public */ LastActivatedTime?: Date | undefined; /** *The ID of user who last activated evaluation form.
* @public */ LastActivatedBy?: string | undefined; /** *Latest version of the evaluation form.
* @public */ LatestVersion: number | undefined; /** *Active version of the evaluation form.
* @public */ ActiveVersion?: number | undefined; /** *Whether automated evaluation is enabled.
* @public */ AutoEvaluationEnabled?: boolean | undefined; /** *The language of the evaluation form.
* @public */ EvaluationFormLanguage?: EvaluationFormLanguageCode | undefined; /** *The contact interaction type for this evaluation form.
* @public */ ContactInteractionType?: ContactInteractionType | 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 returned evaluation forms.
* @public */ EvaluationFormSearchSummaryList?: EvaluationFormSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of evaluation forms that matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *An object to specify the hours of operation override date condition.
* @public */ export interface DateCondition { /** *An object to specify the hours of operation override date field.
* @public */ FieldName?: string | undefined; /** *An object to specify the hours of operation override date value.
* @public */ Value?: string | undefined; /** *An object to specify the hours of operation override date condition comparisonType.
Filters to be applied to search results.
* @public */ export interface HoursOfOperationSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Information about the hours of operations overrides.
* @public */ HoursOfOperationOverrides?: HoursOfOperationOverride[] | 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 total number of hours of operations which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** * @public */ export interface SearchHoursOfOperationsResponse { /** *Information about the hours of operations.
* @public */ HoursOfOperations?: HoursOfOperation[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of hours of operations which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to apply when searching for notifications.
* @public */ export interface NotificationSearchFilter { /** *Attribute-based filters to apply to the search results.
* @public */ AttributeFilter?: ControlPlaneAttributeFilter | undefined; } /** *Summary information about a notification returned from a search operation.
* @public */ export interface NotificationSearchSummary { /** *The unique identifier for the notification.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) of the notification.
* @public */ Arn?: string | undefined; /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId?: string | undefined; /** *The localized content of the notification.
* @public */ Content?: PartialThe priority level of the notification.
* @public */ Priority?: NotificationPriority | undefined; /** *A list of recipient Amazon Resource Names (ARNs).
* @public */ Recipients?: string[] | undefined; /** *The timestamp when the notification was created.
* @public */ CreatedAt?: Date | undefined; /** *The timestamp when the notification expires.
* @public */ ExpiresAt?: Date | undefined; /** *The AWS Region where the notification was last modified.
* @public */ LastModifiedRegion?: string | undefined; /** *The timestamp when the notification was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The tags associated with the notification.
* @public */ Tags?: RecordA list of notifications matching the search criteria.
* @public */ Notifications?: NotificationSearchSummary[] | undefined; /** *The token for the next set of results. If present, there are more results available.
* @public */ NextToken?: string | undefined; /** *The approximate total number of notifications matching the search criteria.
* @public */ ApproximateTotalCount?: number | undefined; } /** * @public */ export interface SearchPredefinedAttributesResponse { /** *Predefined attributes matched by the search criteria.
* @public */ PredefinedAttributes?: PredefinedAttribute[] | 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 approximate number of predefined attributes which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface PromptSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Information about the prompts.
* @public */ Prompts?: Prompt[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of quick connects which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface QueueSearchFilter { /** *An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an
* OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
Information about the queues.
* @public */ Queues?: Queue[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of queues which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; }