Filters to be applied to search results.
* @public */ export interface QuickConnectSearchFilter { /** *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 quick connects.
* @public */ QuickConnects?: QuickConnect[] | 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; } /** *The search criteria to be used to return tags.
* @public */ export interface TagSearchCondition { /** *The tag key used in the tag search condition.
* @public */ tagKey?: string | undefined; /** *The tag value used in the tag search condition.
* @public */ tagValue?: string | undefined; /** *The type of comparison to be made when evaluating the tag key in tag search condition.
* @public */ tagKeyComparisonType?: StringComparisonType | undefined; /** *The type of comparison to be made when evaluating the tag value in tag search condition.
* @public */ tagValueComparisonType?: StringComparisonType | undefined; } /** *The search criteria to be used to search tags.
* @public */ export interface ResourceTagsSearchCriteria { /** *The search criteria to be used to return tags.
* @public */ TagSearchCondition?: TagSearchCondition | undefined; } /** * @public */ export interface SearchResourceTagsRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) * of the instance.
* @public */ InstanceId: string | undefined; /** *The list of resource types to be used to search tags from. If not provided or if any empty list is provided, * this API will search from all supported resource types. Note that lowercase and - are required.
** Supported resource types *
*agent
*agent-state
*routing-profile
*standard-queue
*security-profile
*operating-hours
*prompt
*contact-flow
*flow- module
*transfer-destination (also known as quick connect)
*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 search criteria to be used to return tags.
* @public */ SearchCriteria?: ResourceTagsSearchCriteria | undefined; } /** *A tag set contains tag key and tag value.
* @public */ export interface TagSet { /** *The tag key in the TagSet.
* @public */ key?: string | undefined; /** *The tag value in the tagSet.
* @public */ value?: string | undefined; } /** * @public */ export interface SearchResourceTagsResponse { /** *A list of tags used in the Amazon Connect instance.
* @public */ Tags?: TagSet[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** *Filters to be applied to search results.
* @public */ export interface RoutingProfileSearchFilter { /** *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 routing profiles.
* @public */ RoutingProfiles?: RoutingProfile[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of routing profiles which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface SecurityProfilesSearchFilter { /** *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 returned security profiles.
* @public */ export interface SecurityProfileSearchSummary { /** *The identifier of the security profile.
* @public */ Id?: string | undefined; /** *The organization resource identifier.
* @public */ OrganizationResourceId?: string | undefined; /** *The Amazon Resource Name (ARN) of the security profile.
* @public */ Arn?: string | undefined; /** *The name of the security profile.
* @public */ SecurityProfileName?: string | undefined; /** *The description of the security profile.
* @public */ Description?: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordInformation about the security profiles.
* @public */ SecurityProfiles?: SecurityProfileSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of security profiles which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface TestCaseSearchFilter { /** *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.
* @public */ TagFilter?: ControlPlaneTagFilter | undefined; } /** * @public */ export interface SearchTestCasesResponse { /** *Information about the test cases.
* @public */ TestCases?: TestCase[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of test cases which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Filters to be applied to search results.
* @public */ export interface UserHierarchyGroupSearchFilter { /** *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 userHierarchyGroups.
* @public */ UserHierarchyGroups?: HierarchyGroup[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of userHierarchyGroups which matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ export interface HierarchyGroupCondition { /** *The value in the hierarchy group condition.
* @public */ Value?: string | undefined; /** *The type of hierarchy group match.
* @public */ HierarchyGroupMatchType?: HierarchyGroupMatchType | undefined; } /** *A leaf node condition which can be used to specify a ProficiencyName, ProficiencyValue and * ProficiencyLimit.
* @public */ export interface Condition { /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name and value.
A leaf node condition which can be used to specify a numeric condition.
* @public */ NumberCondition?: NumberCondition | undefined; } /** *A leaf node condition which can be used to specify a List condition to search users with attributes included in * Lists like Proficiencies.
* @public */ export interface ListCondition { /** *The type of target list that will be used to filter the users.
* @public */ TargetListType?: TargetListType | undefined; /** *A list of Condition objects which would be applied together with an AND condition.
* @public */ Conditions?: Condition[] | undefined; } /** *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 */ TagConditions?: TagCondition[] | undefined; /** *A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ HierarchyGroupCondition?: HierarchyGroupCondition | undefined; } /** *An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the
* SearchFilter.
This accepts an OR of 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.
Only one field can be populated. Maximum number of allowed Tag conditions is 25. Maximum number of allowed * Hierarchy Group conditions is 20.
*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, for example, HAVE BPO = 123.
*
A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ HierarchyGroupCondition?: HierarchyGroupCondition | undefined; } /** *Filters to be applied to search results.
* @public */ export interface UserSearchFilter { /** *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.
An object that can be used to specify Tag conditions or Hierarchy Group conditions inside the * SearchFilter.
*This accepts an OR of 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.
Only one field can be populated. This object can’t be used along with TagFilter. Request can either contain * TagFilter or UserAttributeFilter if SearchFilter is specified, combination of both is not supported and such request * will throw AccessDeniedException.
*The user's first name and last name.
* @public */ export interface UserIdentityInfoLite { /** *The user's first name.
* @public */ FirstName?: string | undefined; /** *The user's last name.
* @public */ LastName?: string | undefined; } /** *Information about the returned users.
* @public */ export interface UserSearchSummary { /** *The Amazon Resource Name (ARN) of the user.
* @public */ Arn?: string | undefined; /** *The directory identifier of the user.
* @public */ DirectoryUserId?: string | undefined; /** *The identifier of the user's hierarchy group.
* @public */ HierarchyGroupId?: string | undefined; /** *The identifier of the user's summary.
* @public */ Id?: string | undefined; /** *The user's first name and last name.
* @public */ IdentityInfo?: UserIdentityInfoLite | undefined; /** *Contains information about the phone configuration settings for a user.
* @public */ PhoneConfig?: UserPhoneConfig | undefined; /** *The identifier of the user's routing profile.
* @public */ RoutingProfileId?: string | undefined; /** *The identifiers of the user's security profiles.
* @public */ SecurityProfileIds?: string[] | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordThe name of the user.
* @public */ Username?: string | undefined; /** *The list of auto-accept configuration settings for each channel.
* @public */ AutoAcceptConfigs?: AutoAcceptConfig[] | undefined; /** *The list of after contact work (ACW) timeout configuration settings for each channel.
* @public */ AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined; /** *The list of phone number configuration settings for each channel.
* @public */ PhoneNumberConfigs?: PhoneNumberConfig[] | undefined; /** *The list of persistent connection configuration settings for each channel.
* @public */ PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined; /** *The list of voice enhancement configuration settings for each channel.
* @public */ VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined; } /** * @public */ export interface SearchUsersResponse { /** *Information about the users.
* @public */ Users?: UserSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of users who matched your search query.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Defines filters to apply when searching for views, such as tag-based filters.
* @public */ export interface ViewSearchFilter { /** *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.
A list of views that match the search criteria.
* @public */ Views?: View[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The approximate total number of views that match the search criteria.
* @public */ ApproximateTotalCount?: number | undefined; } /** * @public */ export interface SearchVocabulariesRequest { /** *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; /** *The current state of the custom vocabulary.
* @public */ State?: VocabularyState | undefined; /** *The starting pattern of the name of the vocabulary.
* @public */ NameStartsWith?: 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; } /** *Contains summary information about the custom vocabulary.
* @public */ export interface VocabularySummary { /** *A unique name of the custom vocabulary.
* @public */ Name: string | undefined; /** *The identifier of the custom vocabulary.
* @public */ Id: string | undefined; /** *The Amazon Resource Name (ARN) of the custom vocabulary.
* @public */ Arn: string | undefined; /** *The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see * What is Amazon Transcribe? *
* @public */ LanguageCode: VocabularyLanguageCode | undefined; /** *The current state of the custom vocabulary.
* @public */ State: VocabularyState | undefined; /** *The timestamp when the custom vocabulary was last modified.
* @public */ LastModifiedTime: Date | undefined; /** *The reason why the custom vocabulary was not created.
* @public */ FailureReason?: string | undefined; } /** * @public */ export interface SearchVocabulariesResponse { /** *The list of the available custom vocabularies.
* @public */ VocabularySummaryList?: VocabularySummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; } /** *Defines filters to apply when searching for workspace associations, such as tag-based filters.
* @public */ export interface WorkspaceAssociationSearchFilter { /** *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.
Contains summary information about a workspace association with a user or routing profile.
* @public */ export interface WorkspaceAssociationSearchSummary { /** *The identifier of the workspace.
* @public */ WorkspaceId?: string | undefined; /** *The Amazon Resource Name (ARN) of the workspace.
* @public */ WorkspaceArn?: string | undefined; /** *The identifier of the associated resource (user or routing profile).
* @public */ ResourceId?: string | undefined; /** *The Amazon Resource Name (ARN) of the associated resource.
* @public */ ResourceArn?: string | undefined; /** *The type of resource associated with the workspace. Valid values are: USER and
* ROUTING_PROFILE.
The name of the associated resource.
* @public */ ResourceName?: string | undefined; } /** * @public */ export interface SearchWorkspaceAssociationsResponse { /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of workspace associations that match the search criteria.
* @public */ WorkspaceAssociations?: WorkspaceAssociationSearchSummary[] | undefined; /** *The approximate total number of workspace associations that match the search criteria.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Defines filters to apply when searching for workspaces, such as tag-based filters.
* @public */ export interface WorkspaceSearchFilter { /** *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.
Contains summary information about a workspace returned from a search operation.
* @public */ export interface WorkspaceSearchSummary { /** *The unique identifier of the workspace.
* @public */ Id?: string | undefined; /** *The name of the workspace.
* @public */ Name?: string | undefined; /** *The visibility setting of the workspace.
* @public */ Visibility?: Visibility | undefined; /** *The description of the workspace.
* @public */ Description?: string | undefined; /** *The title displayed for the workspace.
* @public */ Title?: string | undefined; /** *The Amazon Resource Name (ARN) of the workspace.
* @public */ Arn?: string | undefined; /** *The timestamp when the workspace was created.
* @public */ CreatedAt?: Date | undefined; /** *The tags associated with the workspace.
* @public */ Tags?: RecordIf there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *A list of workspaces that match the search criteria.
* @public */ Workspaces?: WorkspaceSearchSummary[] | undefined; /** *The approximate total number of workspaces that match the search criteria.
* @public */ ApproximateTotalCount?: number | undefined; } /** *Chat integration event containing payload to perform different chat actions such as:
*Sending a chat message
*Sending a chat event, such as typing
*Disconnecting from a chat
*Type of chat integration event.
* @public */ Type: ChatEventType | undefined; /** *Type of content. This is required when Type is MESSAGE or EVENT.
For allowed message content types, see the ContentType parameter in the SendMessage topic
* in the Amazon Connect Participant Service API Reference.
For allowed event content types, see the ContentType parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
Content of the message or event. This is required when Type is MESSAGE and for certain
* ContentTypes when Type is EVENT.
For allowed message content, see the Content parameter in the SendMessage topic in the
* Amazon Connect Participant Service API Reference.
For allowed event content, see the Content parameter in the SendEvent topic in the Amazon Connect Participant Service API Reference.
The customer's details.
* @public */ export interface ParticipantDetails { /** *Display name of the participant.
* @public */ DisplayName: string | undefined; } /** *The streaming configuration, such as the Amazon SNS streaming endpoint.
* @public */ export interface ChatStreamingConfiguration { /** *The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish * real-time message streaming for chat conversations.
* @public */ StreamingEndpointArn: string | undefined; } /** *Payload of chat properties to apply when starting a new contact.
* @public */ export interface NewSessionDetails { /** * The supported chat message content types. Supported types are text/plain,
* text/markdown, application/json,
* application/vnd.amazonaws.connect.message.interactive, and
* application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the
* list. For example, all the following lists are valid because they contain text/plain: [text/plain,
* text/markdown, application/json], [text/markdown, text/plain], [text/plain,
* application/json, application/vnd.amazonaws.connect.message.interactive.response].
The customer's details.
* @public */ ParticipantDetails?: ParticipantDetails | undefined; /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordThe streaming configuration, such as the Amazon SNS streaming endpoint.
* @public */ StreamingConfiguration?: ChatStreamingConfiguration | undefined; } /** * @public */ export interface SendChatIntegrationEventRequest { /** *External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the * E164 phone number of the chat customer participant.
* @public */ SourceId: string | undefined; /** *Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect * instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound * Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.
* @public */ DestinationId: string | undefined; /** *Classification of a channel. This is used in part to uniquely identify chat.
*Valid value: ["connect:sms", connect:"WhatsApp"]
*
Chat integration event payload
* @public */ Event: ChatEvent | undefined; /** *Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, * this is ignored.
* @public */ NewSessionDetails?: NewSessionDetails | undefined; } /** * @public */ export interface SendChatIntegrationEventResponse { /** *Identifier of chat contact used to handle integration event. This may be null if the integration event is not * valid without an already existing chat contact.
* @public */ InitialContactId?: string | undefined; /** *Whether handling the integration event resulted in creating a new chat or acting on existing chat.
* @public */ NewChatCreated?: boolean | undefined; } /** *Contains information about a source or destination email address.
* @public */ export interface EmailAddressInfo { /** *The email address, including the domain.
* @public */ EmailAddress: string | undefined; /** *The display name of email address.
* @public */ DisplayName?: string | undefined; } /** *Information about the additional recipients of outbound email.
* @public */ export interface OutboundAdditionalRecipients { /** *Information about the additional CC email address recipients. Email recipients * are limited to 50 total addresses: 1 required recipient in the DestinationEmailAddress field and up to 49 recipients in the 'CcEmailAddresses' field.
* @public */ CcEmailAddresses?: EmailAddressInfo[] | undefined; } /** *Information about the raw email body content.
* @public */ export interface OutboundRawMessage { /** *The email subject.
* @public */ Subject: string | undefined; /** *The email message body.
* @public */ Body: string | undefined; /** *Type of content, that is, text/plain or text/html.
Information about the template attributes.
* @public */ export interface TemplateAttributes { /** *An object that specifies the custom attributes values to use for variables in the message template. This object * contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. *
* @public */ CustomAttributes?: RecordAn object that specifies the customer profile attributes values to use for variables in the message template. * This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the * message template.
* @public */ CustomerProfileAttributes?: string | undefined; } /** *Information about template message configuration.
* @public */ export interface TemplatedMessageConfig { /** *The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
* @public */ KnowledgeBaseId: string | undefined; /** *The identifier of the message template Id.
* @public */ MessageTemplateId: string | undefined; /** *Information about template attributes, that is, CustomAttributes or CustomerProfileAttributes.
* @public */ TemplateAttributes: TemplateAttributes | undefined; } /** *Information about email body content.
* @public */ export interface OutboundEmailContent { /** *The message source type, that is, RAW or TEMPLATE.
Information about template message configuration.
* @public */ TemplatedMessageConfig?: TemplatedMessageConfig | undefined; /** *The raw email body content.
* @public */ RawMessage?: OutboundRawMessage | undefined; } /** *Information about the campaign.
* @public */ export interface SourceCampaign { /** *A unique identifier for a campaign.
* @public */ CampaignId?: string | undefined; /** *A unique identifier for a each request part of same campaign.
* @public */ OutboundRequestId?: string | undefined; } /** * @public */ export interface SendOutboundEmailRequest { /** *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 email address to be used for sending email.
* @public */ FromEmailAddress: EmailAddressInfo | undefined; /** *The email address to send the email to.
* @public */ DestinationEmailAddress: EmailAddressInfo | undefined; /** *The additional recipients address of the email in CC.
* @public */ AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** *The email message body to be sent to the newly created email.
* @public */ EmailMessage: OutboundEmailContent | undefined; /** *Denotes the class of traffic.
*Only the CAMPAIGN traffic type is supported.
*A Campaign object need for Campaign traffic type.
* @public */ SourceCampaign?: SourceCampaign | 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 SendOutboundEmailResponse { } /** * @public */ export interface StartAttachedFileUploadRequest { /** *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 unique identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *A case-sensitive name of the attached file being uploaded.
* @public */ FileName: string | undefined; /** *The size of the attached file in bytes.
* @public */ FileSizeInBytes: number | undefined; /** *Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
* @public */ UrlExpiryInSeconds?: number | undefined; /** *The use case for the file.
* Only ATTACHMENTS are supported.
The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.
*This value must be a valid ARN.
*Represents the identity that created the file.
* @public */ CreatedBy?: CreatedByInfo | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags":
* \{"key1":"value1", "key2":"value2"\} \}.
Fields required when uploading an attached file.
* @public */ export interface UploadUrlMetadata { /** *A pre-signed S3 URL that should be used for uploading the attached file.
* @public */ Url?: string | undefined; /** *The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format:
* yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
A map of headers that should be provided when uploading the attached file.
* @public */ HeadersToInclude?: RecordThe unique identifier of the attached file resource (ARN).
* @public */ FileArn?: string | undefined; /** *The unique identifier of the attached file resource.
* @public */ FileId?: string | undefined; /** *The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format:
* yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
The current status of the attached file.
* @public */ FileStatus?: FileStatusType | undefined; /** *Represents the identity that created the file.
* @public */ CreatedBy?: CreatedByInfo | undefined; /** *The headers to be provided while uploading the file to the URL.
* @public */ UploadUrlMetadata?: UploadUrlMetadata | undefined; } /** *A chat message.
* @public */ export interface ChatMessage { /** *The type of the content. Supported types are text/plain, text/markdown,
* application/json, and
* application/vnd.amazonaws.connect.message.interactive.response.
The content of the chat message.
*For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum
* of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are
* Minimum of 1, Maximum of 12288.
The configuration of the participant.
* @public */ export interface ParticipantConfiguration { /** *The mode in which responses should be sent to the participant.
* @public */ ResponseMode?: ResponseMode | undefined; } /** *Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how * to configure for them, see Enable * persistent chat.
* @public */ export interface PersistentChat { /** *The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for * persistent chat.
*
* ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the
* specified past ended chat session. To use this type, provide the initialContactId of the past ended
* chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent
* chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
* FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the
* sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
* @public */ RehydrationType?: RehydrationType | undefined; /** *The contactId from which a persistent chat session must be started.
* @public */ SourceContactId?: string | undefined; } /** * @public */ export interface StartChatContactResponse { /** *The identifier of this contact within the Amazon Connect instance.
* @public */ ContactId?: string | undefined; /** *The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat * lifecycle.
* @public */ ParticipantId?: string | undefined; /** *The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
* @public */ ParticipantToken?: string | undefined; /** *The contactId from which a persistent chat session is started. This field is populated only for persistent * chats.
* @public */ ContinuedFromContactId?: string | undefined; } /** *Configuration information about automated evaluations.
* @public */ export interface AutoEvaluationConfiguration { /** *Whether automated evaluations are enabled.
* @public */ Enabled: boolean | undefined; } /** * @public */ export interface StartContactEvaluationRequest { /** *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 unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *Whether automated evaluations are enabled.
* @public */ AutoEvaluationConfiguration?: AutoEvaluationConfiguration | 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 tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordA unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; /** *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ EvaluationArn: string | undefined; } /** * @public */ export interface StartContactMediaProcessingRequest { /** *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 Amazon Resource Name (ARN) of the Lambda processor. You can find the Amazon Resource Name of the lambda in * the lambda console.
* @public */ ProcessorArn?: string | undefined; /** *The desired behavior for failed message processing.
* @public */ FailureMode?: ContactMediaProcessingFailureMode | undefined; } /** * @public */ export interface StartContactMediaProcessingResponse { } /** *Contains information about the recording configuration settings.
* @public */ export interface VoiceRecordingConfiguration { /** *Identifies which track is being recorded.
* @public */ VoiceRecordingTrack?: VoiceRecordingTrack | undefined; /** *Identifies which IVR track is being recorded.
*One and only one of the track configurations should be presented in the request.
* @public */ IvrRecordingTrack?: IvrRecordingTrack | undefined; } /** * @public */ export interface StartContactRecordingRequest { /** *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 person being recorded.
* @public */ VoiceRecordingConfiguration: VoiceRecordingConfiguration | undefined; } /** * @public */ export interface StartContactRecordingResponse { } /** * @public */ export interface StartContactStreamingRequest { /** *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. This is the identifier of the contact associated with the first interaction with * the contact center.
* @public */ ContactId: string | undefined; /** *The streaming configuration, such as the Amazon SNS streaming endpoint.
* @public */ ChatStreamingConfiguration: ChatStreamingConfiguration | 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 StartContactStreamingResponse { /** *The identifier of the streaming configuration enabled.
* @public */ StreamingId: string | undefined; } /** *Information about the additional TO and CC recipients of an inbound email contact.
*You can include up to 50 email addresses in total, distributed across DestinationEmailAddress, ToAddresses, and CcAddresses. This total must include
* one required DestinationEmailAddress. You can then specify up to 49 addresses allocated across
* ToAddresses and CcAddresses as needed.
The additional recipients information present in to list. You must have 1
* required recipient (DestinationEmailAddress). You can then specify up to 49 additional recipients
* (across ToAddresses and CcAddresses), for a total of 50 recipients.
The additional recipients information present in cc list. You must have 1
* required recipient (DestinationEmailAddress). You can then specify up to 49 additional recipients
* (across ToAddresses and CcAddresses), for a total of 50 recipients.
Information about the email attachment files.
* @public */ export interface EmailAttachment { /** *A case-sensitive name of the attached file being uploaded.
* @public */ FileName: string | undefined; /** *The pre-signed URLs for the S3 bucket where the email attachment is stored.
* @public */ S3Url: string | undefined; } /** *Information about the raw email body content.
* @public */ export interface InboundRawMessage { /** *The email subject.
* @public */ Subject: string | undefined; /** *The email message body.
* @public */ Body: string | undefined; /** *Type of content, that is, text/plain or text/html.
Headers present in inbound email.
* @public */ Headers?: PartialInformation about email body content.
* @public */ export interface InboundEmailContent { /** *The message source type, that is, RAW.
The raw email body content.
* @public */ RawMessage?: InboundRawMessage | undefined; } /** * @public */ export interface StartEmailContactResponse { /** *The identifier of this contact within the Amazon Connect instance.
* @public */ ContactId?: string | undefined; } /** * @public */ export interface StartOutboundChatContactResponse { /** *The identifier of this contact within the Amazon Connect instance.
* @public */ ContactId?: string | undefined; } /** * @public */ export interface StartOutboundEmailContactRequest { /** *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 email address associated with the Amazon Connect instance.
* @public */ FromEmailAddress?: EmailAddressInfo | undefined; /** *The email address of the customer.
* @public */ DestinationEmailAddress: EmailAddressInfo | undefined; /** *The additional recipients address of email in CC.
* @public */ AdditionalRecipients?: OutboundAdditionalRecipients | undefined; /** *The email message body to be sent to the newly created email.
* @public */ EmailMessage: OutboundEmailContent | 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 StartOutboundEmailContactResponse { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId?: string | undefined; } /** *Configuration of the answering machine detection.
* @public */ export interface AnswerMachineDetectionConfig { /** *The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to
* true, TrafficType must be set as CAMPAIGN.
Wait for the answering machine prompt.
* @public */ AwaitAnswerMachinePrompt?: boolean | undefined; } /** * @public */ export interface StartOutboundVoiceContactRequest { /** *The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
* @public */ Name?: string | undefined; /** *A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information * about CCP logs, see Download and * review CCP logs in the Amazon Connect Administrator Guide.
* @public */ Description?: string | undefined; /** *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following
* reference types at the time of creation: URL | NUMBER | STRING |
* DATE | EMAIL. ATTACHMENT is not a supported reference type during voice
* contact creation.
The contactId that is related to this contact. Linking voice, task, or chat by using
* RelatedContactID copies over contact attributes from the related contact to the new contact. All
* updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits
* to the number of contacts that can be linked by using RelatedContactId.
The phone number of the customer, in E.164 format.
* @public */ DestinationPhoneNumber: string | undefined; /** *The * identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to * Routing, Contact Flows. Choose the flow. On the * flow page, under the name of the flow, choose Show additional flow information. The * ContactFlowId is the last part of the ARN, shown here in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx *
* @public */ ContactFlowId: 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; /** *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. The token is valid for 7 days after creation. If a contact is already started, the contact ID is * returned. *
* @public */ ClientToken?: string | undefined; /** *The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a * source phone number, you must specify a queue.
* @public */ SourcePhoneNumber?: string | undefined; /** *The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified * in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, * you must specify a source phone number.
* @public */ QueueId?: string | undefined; /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordConfiguration of the answering machine detection for this outbound call.
* @public */ AnswerMachineDetectionConfig?: AnswerMachineDetectionConfig | undefined; /** *The campaign identifier of the outbound communication.
* @public */ CampaignId?: string | undefined; /** *Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect.
* The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is
* set to true. For all other cases, use GENERAL.
Information about the outbound strategy.
* @public */ OutboundStrategy?: OutboundStrategy | undefined; /** *The maximum time the outbound call will wait for the destination to answer the call, in seconds
* @public */ RingTimeoutInSeconds?: number | undefined; } /** * @public */ export interface StartOutboundVoiceContactResponse { /** *The identifier of this contact within the Amazon Connect instance.
* @public */ ContactId?: string | undefined; } /** * @public */ export interface StartScreenSharingRequest { /** *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 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; } /** * @public */ export interface StartScreenSharingResponse { } /** *Information about the task attachment files.
* @public */ export interface TaskAttachment { /** *A case-sensitive name of the attached file being uploaded.
* @public */ FileName: string | undefined; /** *The pre-signed URLs for the S3 bucket where the task attachment is stored.
* @public */ S3Url: string | undefined; } /** * @public */ export interface StartTaskContactResponse { /** *The identifier of this contact within the Amazon Connect instance.
* @public */ ContactId?: string | undefined; } /** * @public */ export interface StartTestCaseExecutionRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case to execute.
* @public */ TestCaseId: 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 StartTestCaseExecutionResponse { /** *The identifier of the test case execution.
* @public */ TestCaseExecutionId?: string | undefined; /** *The identifier of the test case resource that was executed.
* @public */ TestCaseId?: string | undefined; /** *The status of a test case execution.
* @public */ Status?: TestCaseExecutionStatus | undefined; } /** * @public */ export interface StartWebRTCContactRequest { /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, -, and _ characters.
* @public */ Attributes?: 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.
*The token is valid for 7 days after creation. If a contact is already started, the contact ID is * returned.
* @public */ ClientToken?: string | undefined; /** *The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to * Routing, Flows. Choose the flow. On the flow page, * under the name of the flow, choose Show additional flow information. The * ContactFlowId is the last part of the ARN, shown here in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx *
* @public */ ContactFlowId: 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 the video sharing capabilities of the participants (customer, agent).
* @public */ AllowedCapabilities?: AllowedCapabilities | undefined; /** *The customer's details.
* @public */ ParticipantDetails: ParticipantDetails | undefined; /** *The unique identifier for an Amazon Connect contact. This identifier is related to the contact * starting.
* @public */ RelatedContactId?: string | undefined; /** *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
* reference types at the time of creation: URL | NUMBER | STRING |
* DATE | EMAIL. ATTACHMENT is not a supported reference type during task
* creation.
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
* @public */ Description?: string | undefined; } /** *The attendee information, including attendee ID and join token.
* @public */ export interface Attendee { /** *The Amazon Chime SDK attendee ID.
* @public */ AttendeeId?: string | undefined; /** *The join token used by the Amazon Chime SDK attendee.
* @public */ JoinToken?: string | undefined; } /** *A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK * meeting.
* @public */ export interface MediaPlacement { /** *The audio host URL.
* @public */ AudioHostUrl?: string | undefined; /** *The audio fallback URL.
* @public */ AudioFallbackUrl?: string | undefined; /** *The signaling URL.
* @public */ SignalingUrl?: string | undefined; /** *The turn control URL.
* @public */ TurnControlUrl?: string | undefined; /** *The event ingestion URL to which you send client meeting events.
* @public */ EventIngestionUrl?: string | undefined; } /** *Has audio-specific configurations as the operating parameter for Echo Reduction.
* @public */ export interface AudioFeatures { /** *Makes echo reduction available to clients who connect to the meeting.
* @public */ EchoReduction?: MeetingFeatureStatus | undefined; } /** *The configuration settings of the features available to a meeting.
* @public */ export interface MeetingFeaturesConfiguration { /** *The configuration settings for the audio features available to a meeting.
* @public */ Audio?: AudioFeatures | undefined; } /** *A meeting created using the Amazon Chime SDK.
* @public */ export interface Meeting { /** *The Amazon Web Services Region in which you create the meeting.
* @public */ MediaRegion?: string | undefined; /** *The media placement for the meeting.
* @public */ MediaPlacement?: MediaPlacement | undefined; /** *The configuration settings of the features available to a meeting.
* @public */ MeetingFeatures?: MeetingFeaturesConfiguration | undefined; /** *The Amazon Chime SDK meeting ID.
* @public */ MeetingId?: string | undefined; } /** *Information required to join the call.
* @public */ export interface ConnectionData { /** *The attendee information, including attendee ID and join token.
* @public */ Attendee?: Attendee | undefined; /** *A meeting created using the Amazon Chime SDK.
* @public */ Meeting?: Meeting | undefined; } /** * @public */ export interface StartWebRTCContactResponse { /** *Information required for the client application (mobile application or website) to connect to the call.
* @public */ ConnectionData?: ConnectionData | undefined; /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId?: string | undefined; /** *The identifier for a contact participant. The ParticipantId for a contact participant is the same
* throughout the contact lifecycle.
The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact * participant.
* @public */ ParticipantToken?: string | undefined; } /** *Contains details about why a contact was disconnected. Only Amazon Connect outbound campaigns can provide * this field.
* @public */ export interface DisconnectReason { /** *A code that indicates how the contact was terminated.
* @public */ Code?: string | undefined; } /** * @public */ export interface StopContactRequest { /** *The ID of the contact.
* @public */ ContactId: 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 reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field. For * a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts) * see DisconnectReason under ContactTraceRecord in the * Amazon Connect Administrator Guide.
* @public */ DisconnectReason?: DisconnectReason | undefined; } /** * @public */ export interface StopContactResponse { } /** * @public */ export interface StopContactMediaProcessingRequest { /** *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; } /** * @public */ export interface StopContactMediaProcessingResponse { } /** * @public */ export interface StopContactRecordingRequest { /** *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 StopContactRecordingResponse { } /** * @public */ export interface StopContactStreamingRequest { /** *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. This is the identifier of the contact that is associated with the first * interaction with the contact center.
* @public */ ContactId: string | undefined; /** *The identifier of the streaming configuration enabled.
* @public */ StreamingId: string | undefined; } /** * @public */ export interface StopContactStreamingResponse { } /** * @public */ export interface StopTestCaseExecutionRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case execution to stop.
* @public */ TestCaseExecutionId: string | undefined; /** *The identifier of the test case.
* @public */ TestCaseId: 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 StopTestCaseExecutionResponse { } /** *Information about input answers for a contact evaluation.
* @public */ export interface EvaluationAnswerInput { /** *The value for an answer in a contact evaluation.
* @public */ Value?: EvaluationAnswerData | undefined; } /** *Represents the entity that performed the action on the evaluation.
* @public */ export type EvaluatorUserUnion = EvaluatorUserUnion.ConnectUserArnMember | EvaluatorUserUnion.$UnknownMember; /** * @public */ export declare namespace EvaluatorUserUnion { /** *Represents the Amazon Connect ARN of the user.
* @public */ interface ConnectUserArnMember { ConnectUserArn: string; $unknown?: never; } /** * @public */ interface $UnknownMember { ConnectUserArn?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; /** *A map of question identifiers to answer value.
* @public */ Answers?: RecordA map of question identifiers to note value.
* @public */ Notes?: RecordThe ID of the user who submitted the contact evaluation.
* @public */ SubmittedBy?: EvaluatorUserUnion | undefined; } /** * @public */ export interface SubmitContactEvaluationResponse { /** *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; } /** * @public */ export interface SuspendContactRecordingRequest { /** *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 SuspendContactRecordingResponse { } /** * @public */ export interface TagContactRequest { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: 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 tags to be assigned to the contact resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} * \}.
*Authorization is not supported by this tag.
*The Amazon Resource Name (ARN) of the resource.
* @public */ resourceArn: string | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ tags: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: string | undefined; /** *The identifier for the queue.
* @public */ QueueId?: string | undefined; /** *The identifier for the user. This can be the ID or the ARN of the user.
* @public */ UserId?: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: 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 TransferContactResponse { /** *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; } /** * @public */ export interface UntagContactRequest { /** *The identifier of the contact in this instance of Amazon Connect.
* @public */ ContactId: 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; /** *A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.
* @public */ TagKeys: string[] | undefined; } /** * @public */ export interface UntagContactResponse { } /** * @public */ export interface UntagResourceRequest { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ resourceArn: string | undefined; /** *The tag keys.
* @public */ tagKeys: string[] | undefined; } /** * @public */ export interface UpdateAgentStatusRequest { /** *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; /** *The name of the agent status.
* @public */ Name?: string | undefined; /** *The description of the agent status.
* @public */ Description?: string | undefined; /** *The state of the agent status.
* @public */ State?: AgentStatusState | undefined; /** *The display order of the agent status.
* @public */ DisplayOrder?: number | undefined; /** *A number indicating the reset order of the agent status.
* @public */ ResetOrderNumber?: boolean | undefined; } /** * @public */ export interface UpdateAttachedFilesConfigurationRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The scope of the attachment. Valid values are EMAIL, CHAT, CASE, and TASK.
The 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 UpdateAttachedFilesConfigurationResponse { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The scope of the attachment.
* @public */ AttachmentScope: AttachmentScope | undefined; /** *The maximum size limit for attached files in bytes.
* @public */ MaximumSizeLimitInBytes?: number | undefined; /** *The configuration for allowed file extensions.
* @public */ ExtensionConfiguration?: ExtensionConfiguration | undefined; /** *The timestamp when the configuration was last modified.
* @public */ LastModifiedTime?: Date | undefined; } /** * @public */ export interface UpdateAuthenticationProfileRequest { /** *A unique identifier for the authentication profile.
* @public */ AuthenticationProfileId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The name for the authentication profile.
* @public */ Name?: string | undefined; /** *The description for the authentication profile.
* @public */ Description?: string | undefined; /** *A list of IP address range strings that are allowed to access the instance. For more information on how to * configure IP addresses, seeConfigure session * timeouts in the Amazon Connect Administrator Guide.
* @public */ AllowedIps?: string[] | undefined; /** *A list of IP address range strings that are blocked from accessing the instance. For more information on how to * configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access * control in the Amazon Connect Administrator Guide.
* @public */ BlockedIps?: string[] | undefined; /** *The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value * determines the maximum possible time before an agent is authenticated. For more information, For more information on * how to configure IP addresses, see Configure session * timeouts in the Amazon Connect Administrator Guide.
* * @deprecated (since 10/31/2025) PeriodicSessionDuration is deprecated. Use SessionInactivityDuration instead. * @public */ PeriodicSessionDuration?: number | undefined; /** *The period, in minutes, before an agent is automatically signed out of the contact center when they go * inactive.
* @public */ SessionInactivityDuration?: number | undefined; /** *Determines if automatic logout on user inactivity is enabled.
* @public */ SessionInactivityHandlingEnabled?: boolean | undefined; } /** *Information about a queue.
* @public */ export interface QueueInfoInput { /** *The identifier of the queue.
* @public */ Id?: string | undefined; } /** * @public */ export interface UpdateContactResponse { } /** * @public */ export interface UpdateContactAttributesRequest { /** *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 identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact * attributes.
*You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
*In the Set contact * attributes block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error * branch of the flow. As a mitigation, consider the following options:
*Remove unnecessary attributes by setting their values to empty.
*If the attributes are only used in one flow and don't need to be referred to outside of that flow (for * example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB * of information from one flow to another. For more information, see Flow block: Set contact attributes in the * Amazon Connect Administrator Guide.
*The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique identifier for the contact evaluation.
* @public */ EvaluationId: string | undefined; /** *A map of question identifiers to answer value.
* @public */ Answers?: RecordA map of question identifiers to note value.
* @public */ Notes?: RecordThe ID of the user who updated the contact evaluation.
* @public */ UpdatedBy?: EvaluatorUserUnion | undefined; } /** * @public */ export interface UpdateContactEvaluationResponse { /** *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; } /** * @public */ export interface UpdateContactFlowContentRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; /** *The JSON string that represents the content of the flow. For an example, see Example * flow in Amazon Connect Flow language.
*Length Constraints: Minimum length of 1. Maximum length of 256000.
* @public */ Content: string | undefined; } /** * @public */ export interface UpdateContactFlowContentResponse { } /** * @public */ export interface UpdateContactFlowMetadataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; /** *The name of the flow.
* @public */ Name?: string | undefined; /** *The description of the flow.
* @public */ Description?: string | undefined; /** *The state of flow.
* @public */ ContactFlowState?: ContactFlowState | undefined; } /** * @public */ export interface UpdateContactFlowMetadataResponse { } /** * @public */ export interface UpdateContactFlowModuleAliasRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow module.
* @public */ ContactFlowModuleId: string | undefined; /** *The identifier of the alias.
* @public */ AliasId: string | undefined; /** *The name of the alias.
* @public */ Name?: string | undefined; /** *The description of the alias.
* @public */ Description?: string | undefined; /** *The version of the flow module.
* @public */ ContactFlowModuleVersion?: number | undefined; } /** * @public */ export interface UpdateContactFlowModuleAliasResponse { } /** * @public */ export interface UpdateContactFlowModuleContentRequest { /** *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 JSON string that represents the content of the flow. For an example, see Example * flow in Amazon Connect Flow language.
* @public */ Content?: string | undefined; /** *Serialized JSON string of the flow module Settings schema.
* @public */ Settings?: string | undefined; } /** * @public */ export interface UpdateContactFlowModuleContentResponse { } /** * @public */ export interface UpdateContactFlowModuleMetadataRequest { /** *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 name of the flow module.
* @public */ Name?: string | undefined; /** *The description of the flow module.
* @public */ Description?: string | undefined; /** *The state of flow module.
* @public */ State?: ContactFlowModuleState | undefined; } /** * @public */ export interface UpdateContactFlowModuleMetadataResponse { } /** * @public */ export interface UpdateContactFlowNameRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the flow.
* @public */ ContactFlowId: string | undefined; /** *The name of the flow.
* @public */ Name?: string | undefined; /** *The description of the flow.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateContactFlowNameResponse { } /** *Specify whether this routing criteria step should apply for only a limited amount of time, or if it should never * expire.
* @public */ export interface RoutingCriteriaInputStepExpiry { /** *The number of seconds that the contact will be routed only to agents matching this routing step, if expiry was * configured for this routing step.
* @public */ DurationInSeconds?: number | undefined; } /** * @public */ export interface UpdateContactRoutingDataResponse { } /** * @public */ export interface UpdateContactScheduleRequest { /** *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 timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
* @public */ ScheduledTime: Date | undefined; } /** * @public */ export interface UpdateContactScheduleResponse { } /** * @public */ export interface UpdateDataTableAttributeRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
* @public */ DataTableId: string | undefined; /** *The current name of the attribute to update. Used as an identifier since attribute names can be changed.
* @public */ AttributeName: string | undefined; /** *The new name for the attribute. Must conform to Connect human readable string specification and be unique within * the data table.
* @public */ Name: string | undefined; /** *The updated value type for the attribute. When changing value types, existing values are not deleted but may * return default values if incompatible.
* @public */ ValueType: DataTableAttributeValueType | undefined; /** *The updated description for the attribute.
* @public */ Description?: string | undefined; /** *Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing * values to maintain uniqueness.
* @public */ Primary?: boolean | undefined; /** *The updated validation rules for the attribute. Changes do not affect existing values until they are * modified.
* @public */ Validation?: Validation | undefined; } /** * @public */ export interface UpdateDataTableAttributeResponse { /** *The trimmed name and identifier for the updated attribute.
* @public */ Name: string | undefined; /** *The new lock version for the attribute after the update.
* @public */ LockVersion: DataTableLockVersion | undefined; } /** * @public */ export interface UpdateDataTableMetadataRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the * version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails * with an error.
* @public */ DataTableId: string | undefined; /** *The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 * characters. Must be unique for the instance using case-insensitive comparison.
* @public */ Name: string | undefined; /** *The updated description for the data table. Must conform to Connect human readable string specification and have * 0-250 characters.
* @public */ Description?: string | undefined; /** *The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and * NONE.
* @public */ ValueLockLevel: DataTableLockLevel | undefined; /** *The updated IANA timezone identifier to use when resolving time based dynamic values.
* @public */ TimeZone: string | undefined; } /** * @public */ export interface UpdateDataTableMetadataResponse { /** *The new lock version for the data table after the update.
* @public */ LockVersion: DataTableLockVersion | undefined; } /** * @public */ export interface UpdateDataTablePrimaryValuesRequest { /** *The unique identifier for the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the * version is provided as part of the identifier or ARN, the version must be one of the two available system managed * aliases, $SAVED or $LATEST.
* @public */ DataTableId: string | undefined; /** *The current primary values for the record. Required and must include values for all primary attributes. Fails if * the table has primary attributes and some primary values are omitted.
* @public */ PrimaryValues: PrimaryValue[] | undefined; /** *The new primary values for the record. Required and must include values for all primary attributes. The * combination must be unique within the table.
* @public */ NewPrimaryValues: PrimaryValue[] | undefined; /** *The lock version information required for optimistic locking to prevent concurrent modifications.
* @public */ LockVersion: DataTableLockVersion | undefined; } /** * @public */ export interface UpdateDataTablePrimaryValuesResponse { /** *The updated lock version information for the data table and affected components after the primary values * change.
* @public */ LockVersion: DataTableLockVersion | undefined; } /** * @public */ export interface UpdateEmailAddressMetadataRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the email address.
* @public */ EmailAddressId: string | undefined; /** *The description of the email address.
* @public */ Description?: string | undefined; /** *The display name of email address.
* @public */ DisplayName?: 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 UpdateEmailAddressMetadataResponse { /** *The identifier of the email address.
* @public */ EmailAddressId?: string | undefined; /** *The Amazon Resource Name (ARN) of the email address.
* @public */ EmailAddressArn?: string | undefined; } /** * @public */ export interface UpdateEvaluationFormResponse { /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *The Amazon Resource Name (ARN) for the contact evaluation resource.
* @public */ EvaluationFormArn: string | undefined; /** *The version of the updated evaluation form resource.
* @public */ EvaluationFormVersion: number | undefined; } /** * @public */ export interface UpdateHoursOfOperationRequest { /** *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 hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The name of the hours of operation.
* @public */ Name?: string | undefined; /** *The description of the hours of operation.
* @public */ Description?: string | undefined; /** *The time zone of the hours of operation.
* @public */ TimeZone?: string | undefined; /** *Configuration information of the hours of operation.
* @public */ Config?: HoursOfOperationConfig[] | undefined; } /** * @public */ export interface UpdateHoursOfOperationOverrideRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; /** *The identifier for the hours of operation override.
* @public */ HoursOfOperationOverrideId: string | undefined; /** *The name of the hours of operation override.
* @public */ Name?: string | undefined; /** *The description of the hours of operation override.
* @public */ Description?: string | undefined; /** *Configuration information for the hours of operation override: day, start time, and end time.
* @public */ Config?: HoursOfOperationOverrideConfig[] | undefined; /** *The date from when the hours of operation override would be effective.
* @public */ EffectiveFrom?: string | undefined; /** *The date until the hours of operation override is effective.
* @public */ EffectiveTill?: string | undefined; /** *Configuration for a recurring event.
* @public */ RecurrenceConfig?: RecurrenceConfig | undefined; /** *Whether the override will be defined as a standard or as a recurring event.
*For more information about how override types are applied, see Build your list of overrides in the * Administrator Guide.
* @public */ OverrideType?: OverrideType | undefined; } /** * @public */ export interface UpdateInstanceAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The type of attribute.
*Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.
*If you set the attribute type as MESSAGE_STREAMING, you need to update the Lex bot alias resource
* based policy to include the lex:RecognizeMessageAsync action for the connect instance ARN
* resource.
The value for the attribute. Maximum character limit is 100.
* @public */ Value: 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 UpdateInstanceStorageConfigRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
* @public */ AssociationId: string | undefined; /** *A valid resource type.
* @public */ ResourceType: InstanceStorageResourceType | undefined; /** *The storage configuration for the instance.
* @public */ StorageConfig: InstanceStorageConfig | 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 UpdateNotificationContentRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the notification to update.
* @public */ NotificationId: string | undefined; /** *The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.
* @public */ Content: PartialThe response from updating notification content.
* @public */ export interface UpdateNotificationContentResponse { } /** * @public */ export interface UpdateParticipantAuthenticationRequest { /** *The state query parameter that was provided by Cognito in the redirectUri. This will
* also match the state parameter provided in the AuthenticationUrl from the GetAuthenticationUrl
* 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 code query parameter provided by Cognito in the redirectUri.
The error query parameter provided by Cognito in the redirectUri.
The error_description parameter provided by Cognito in the redirectUri.
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the
* timer in minutes. Only one value can be set.
For more information about how chat timeouts work, see * Set up chat timeouts for human participants.
* @public */ export type ParticipantTimerValue = ParticipantTimerValue.ParticipantTimerActionMember | ParticipantTimerValue.ParticipantTimerDurationInMinutesMember | ParticipantTimerValue.$UnknownMember; /** * @public */ export declare namespace ParticipantTimerValue { /** *The timer action. Currently only one value is allowed: Unset. It deletes a timer.
The duration of a timer, in minutes.
* @public */ interface ParticipantTimerDurationInMinutesMember { ParticipantTimerAction?: never; ParticipantTimerDurationInMinutes: number; $unknown?: never; } /** * @public */ interface $UnknownMember { ParticipantTimerAction?: never; ParticipantTimerDurationInMinutes?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorConfiguration information for the timer. After the timer configuration is set, it persists for the duration of * the chat. It persists across new contacts in the chain, for example, transfer contacts.
*For more information about how chat timeouts work, see * Set up chat timeouts for human participants.
* @public */ export interface ParticipantTimerConfiguration { /** *The role of the participant in the chat conversation.
* @public */ ParticipantRole: TimerEligibleParticipantRoles | undefined; /** *The type of timer. IDLE indicates the timer applies for considering a human chat participant as
* idle. DISCONNECT_NONCUSTOMER indicates the timer applies to automatically disconnecting a chat
* participant due to idleness.
The value of the timer. Either the timer action (Unset to delete the timer), or the duration of the timer in * minutes. Only one value can be set.
* @public */ TimerValue: ParticipantTimerValue | undefined; } /** *Configuration information for the chat participant role.
* @public */ export interface ChatParticipantRoleConfig { /** *A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries * error out the request with a 400.
* @public */ ParticipantTimerConfigList: ParticipantTimerConfiguration[] | undefined; } /** *Configuration information for the chat participant role.
* @public */ export type UpdateParticipantRoleConfigChannelInfo = UpdateParticipantRoleConfigChannelInfo.ChatMember | UpdateParticipantRoleConfigChannelInfo.$UnknownMember; /** * @public */ export declare namespace UpdateParticipantRoleConfigChannelInfo { /** *Configuration information for the chat participant role.
* @public */ interface ChatMember { Chat: ChatParticipantRoleConfig; $unknown?: never; } /** * @public */ interface $UnknownMember { Chat?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe 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 Amazon Connect channel you want to configure.
* @public */ ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined; } /** * @public */ export interface UpdateParticipantRoleConfigResponse { } /** * @public */ export interface UpdatePhoneNumberRequest { /** *A unique identifier for the phone number.
* @public */ PhoneNumberId: string | undefined; /** *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.
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 UpdatePhoneNumberResponse { /** *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 UpdatePhoneNumberMetadataRequest { /** *The Amazon Resource Name (ARN) or resource ID of the phone number.
* @public */ PhoneNumberId: string | undefined; /** *The description of the phone number.
* @public */ PhoneNumberDescription?: 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 UpdatePredefinedAttributeRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance.
* @public */ InstanceId: string | undefined; /** *The name of the predefined attribute.
* @public */ Name: string | undefined; /** *The values of the predefined attribute.
* @public */ Values?: PredefinedAttributeValues | undefined; /** *Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.
* @public */ Purposes?: string[] | undefined; /** *Custom metadata that is associated to predefined attributes to control behavior * in upstream services, such as controlling * how a predefined attribute should be displayed in the Amazon Connect admin website.
* @public */ AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined; } /** * @public */ export interface UpdatePromptRequest { /** *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; /** *The name of the prompt.
* @public */ Name?: string | undefined; /** *A description of the prompt.
* @public */ Description?: string | undefined; /** *The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the * GetPromptFile * API instead of providing S3 URIs.
* @public */ S3Uri?: string | undefined; } /** * @public */ export interface UpdatePromptResponse { /** *The Amazon Resource Name (ARN) of the prompt.
* @public */ PromptARN?: string | undefined; /** *A unique identifier for the prompt.
* @public */ PromptId?: string | undefined; } /** * @public */ export interface UpdateQueueHoursOfOperationRequest { /** *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 identifier for the hours of operation.
* @public */ HoursOfOperationId: string | undefined; } /** * @public */ export interface UpdateQueueMaxContactsRequest { /** *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 maximum number of contacts that can be in the queue before it is considered full.
* @public */ MaxContacts?: number | undefined; } /** * @public */ export interface UpdateQueueNameRequest { /** *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 name of the queue.
* @public */ Name?: string | undefined; /** *The description of the queue.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateQueueOutboundCallerConfigRequest { /** *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 outbound caller ID name, number, and outbound whisper flow.
* @public */ OutboundCallerConfig: OutboundCallerConfig | undefined; } /** * @public */ export interface UpdateQueueOutboundEmailConfigRequest { /** *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 outbound email address ID for a specified queue.
* @public */ OutboundEmailConfig: OutboundEmailConfig | undefined; } /** * @public */ export interface UpdateQueueStatusRequest { /** *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 status of the queue.
* @public */ Status: QueueStatus | undefined; } /** * @public */ export interface UpdateQuickConnectConfigRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the quick connect.
* @public */ QuickConnectId: string | undefined; /** *Information about the configuration settings for the quick connect.
* @public */ QuickConnectConfig: QuickConnectConfig | undefined; } /** * @public */ export interface UpdateQuickConnectNameRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier for the quick connect.
* @public */ QuickConnectId: string | undefined; /** *The name of the quick connect.
* @public */ Name?: string | undefined; /** *The description of the quick connect.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { /** *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; /** *Whether agents with this routing profile will have their routing order calculated based on time since * their last inbound contact or longest idle time.
* @public */ AgentAvailabilityTimer: AgentAvailabilityTimer | undefined; } /** * @public */ export interface UpdateRoutingProfileConcurrencyRequest { /** *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 channels that agents can handle in the Contact Control Panel (CCP).
* @public */ MediaConcurrencies: MediaConcurrency[] | undefined; } /** * @public */ export interface UpdateRoutingProfileDefaultOutboundQueueRequest { /** *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 identifier for the default outbound queue.
* @public */ DefaultOutboundQueueId: string | undefined; } /** * @public */ export interface UpdateRoutingProfileNameRequest { /** *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 name of the routing profile. Must not be more than 127 characters.
* @public */ Name?: string | undefined; /** *The description of the routing profile. Must not be more than 250 characters.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateRoutingProfileQueuesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the routing profile.
* @public */ RoutingProfileId: string | undefined; /** *The queues to be updated for this routing profile. Queues must * first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
* @public */ QueueConfigs: RoutingProfileQueueConfig[] | undefined; } /** * @public */ export interface UpdateRuleRequest { /** *A unique identifier for the rule.
* @public */ RuleId: 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 name of the rule. You can change the name only if TriggerEventSource is one of the following
* values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate |
* OnSalesforceCaseCreate
*
The conditions of the rule.
* @public */ Function: string | undefined; /** *A list of actions to be run when the rule is triggered.
* @public */ Actions: RuleAction[] | undefined; /** *The publish status of the rule.
* @public */ PublishStatus: RulePublishStatus | undefined; } /** * @public */ export interface UpdateSecurityProfileRequest { /** *The description of the security profile.
* @public */ Description?: string | undefined; /** *The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
* @public */ Permissions?: string[] | undefined; /** *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 list of tags that a security profile uses to restrict access to resources in Amazon Connect.
* @public */ AllowedAccessControlTags?: RecordThe list of resources that a security profile applies tag restrictions to in Amazon Connect.
* @public */ TagRestrictedResources?: string[] | undefined; /** *A list of the third-party application's metadata.
* @public */ Applications?: Application[] | undefined; /** *The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following
* are acceptable ResourceNames: User.
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
* @public */ AllowedAccessControlHierarchyGroupId?: string | undefined; /** *A list of Flow Modules an AI Agent can invoke as a tool
* @public */ AllowedFlowModules?: FlowModule[] | undefined; /** *The granular access control configuration for the security profile, including data table permissions.
* @public */ GranularAccessControlConfiguration?: GranularAccessControlConfiguration | undefined; } /** * @public */ export interface UpdateTaskTemplateRequest { /** *A unique identifier for the task template.
* @public */ TaskTemplateId: 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 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; /** *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.
Fields that are part of the template.
* @public */ Fields?: TaskTemplateField[] | undefined; } /** * @public */ export interface UpdateTaskTemplateResponse { /** *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 task template resource.
* @public */ Id?: string | undefined; /** *The Amazon Resource Name (ARN) for the task template resource.
* @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; } /** * @public */ export interface UpdateTestCaseRequest { /** *The identifier of the Amazon Connect instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the test case to update.
* @public */ TestCaseId: string | undefined; /** *The JSON string that represents the content of the test.
* @public */ Content?: string | undefined; /** *Defines the starting point for your test.
* @public */ EntryPoint?: TestCaseEntryPoint | undefined; /** *Defines the test attributes for precise data representation.
* @public */ InitializationData?: string | undefined; /** *The name of the test case.
* @public */ Name?: string | undefined; /** *The description of the test case.
* @public */ Description?: string | undefined; /** *Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.
* @public */ Status?: TestCaseStatus | undefined; /** *The time at which the resource was last modified.
* @public */ LastModifiedTime?: Date | undefined; /** *The region in which the resource was last modified
* @public */ LastModifiedRegion?: string | undefined; } /** * @public */ export interface UpdateTestCaseResponse { } /** * @public */ export interface UpdateTrafficDistributionRequest { /** *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 traffic between the instance and its replica(s).
* @public */ TelephonyConfig?: TelephonyConfig | 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 UpdateTrafficDistributionResponse { } /** * @public */ export interface UpdateUserConfigRequest { /** *The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.
* @public */ AutoAcceptConfigs?: AutoAcceptConfig[] | undefined; /** *The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.
* @public */ AfterContactWorkConfigs?: AfterContactWorkConfigPerChannel[] | undefined; /** *The list of phone number configuration settings for each channel.
* @public */ PhoneNumberConfigs?: PhoneNumberConfig[] | undefined; /** *The list of persistent connection configuration settings for each channel.
* @public */ PersistentConnectionConfigs?: PersistentConnectionConfig[] | undefined; /** *The list of voice enhancement configuration settings for each channel.
* @public */ VoiceEnhancementConfigs?: VoiceEnhancementConfig[] | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserHierarchyRequest { /** *The identifier of the hierarchy group.
* @public */ HierarchyGroupId?: string | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserHierarchyGroupNameRequest { /** *The name of the hierarchy group. Must not be more than 100 characters.
* @public */ Name: string | undefined; /** *The identifier of the hierarchy group.
* @public */ HierarchyGroupId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** *Contains information about the hierarchy level to update.
* @public */ export interface HierarchyLevelUpdate { /** *The name of the user hierarchy level. Must not be more than 50 characters.
* @public */ Name: string | undefined; } /** *Contains information about the level hierarchy to update.
* @public */ export interface HierarchyStructureUpdate { /** *The * update * for level one.
* @public */ LevelOne?: HierarchyLevelUpdate | undefined; /** *The update for level two.
* @public */ LevelTwo?: HierarchyLevelUpdate | undefined; /** *The update for level three.
* @public */ LevelThree?: HierarchyLevelUpdate | undefined; /** *The update for level four.
* @public */ LevelFour?: HierarchyLevelUpdate | undefined; /** *The update for level five.
* @public */ LevelFive?: HierarchyLevelUpdate | undefined; } /** * @public */ export interface UpdateUserHierarchyStructureRequest { /** *The hierarchy levels to update.
* @public */ HierarchyStructure: HierarchyStructureUpdate | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserIdentityInfoRequest { /** *The identity information for the user.
* @public */ IdentityInfo: UserIdentityInfo | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserNotificationStatusRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the notification.
* @public */ NotificationId: string | undefined; /** *The identifier of the user whose notification status is being updated.
* @public */ UserId: string | undefined; /** *The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.
* @public */ Status: NotificationStatus | undefined; /** *The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.
* @public */ LastModifiedTime?: Date | undefined; /** *The AWS Region where the notification status was last modified. Used for cross-region replication.
* @public */ LastModifiedRegion?: string | undefined; } /** *The response from updating a user's notification status.
* @public */ export interface UpdateUserNotificationStatusResponse { } /** * @public */ export interface UpdateUserPhoneConfigRequest { /** *Information about phone configuration settings for the user.
* @public */ PhoneConfig: UserPhoneConfig | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserProficienciesRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the * instance.
* @public */ InstanceId: string | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do * this using AssociateUserProficiencies API.
* @public */ UserProficiencies: UserProficiency[] | undefined; } /** * @public */ export interface UpdateUserRoutingProfileRequest { /** *The identifier of the routing profile for the user.
* @public */ RoutingProfileId: string | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateUserSecurityProfilesRequest { /** *The identifiers of the security profiles for the user.
* @public */ SecurityProfileIds: string[] | undefined; /** *The identifier of the user account.
* @public */ UserId: string | undefined; /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; } /** * @public */ export interface UpdateViewContentRequest { /** *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.
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED
* status will initiate validation on the content.
View content containing all content necessary to render a view except for runtime input data and the runtime * input schema, which is auto-generated by this operation.
*The total uncompressed content has a maximum file size of 400kB.
* @public */ Content: ViewInputContent | undefined; } /** * @public */ export interface UpdateViewContentResponse { /** *A view resource object. Contains metadata and content necessary to render the view.
* @public */ View?: View | undefined; } /** * @public */ export interface UpdateViewMetadataRequest { /** *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 name of the view.
* @public */ Name?: string | undefined; /** *The description of the view.
* @public */ Description?: string | undefined; } /** * @public */ export interface UpdateViewMetadataResponse { } /** * @public */ export interface UpdateWorkspaceMetadataRequest { /** *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 name of the workspace.
* @public */ Name?: string | undefined; /** *The description of the workspace.
* @public */ Description?: string | undefined; /** *The title displayed for the workspace.
* @public */ Title?: string | undefined; } /** * @public */ export interface UpdateWorkspaceMetadataResponse { } /** * @public */ export interface UpdateWorkspacePageRequest { /** *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 current page identifier.
* @public */ Page: string | undefined; /** *The new page identifier, if changing the page name.
* @public */ NewPage?: string | undefined; /** *The Amazon Resource Name (ARN) of the view to associate with the page.
* @public */ ResourceArn?: string | undefined; /** *The URL-friendly identifier for the page.
* @public */ Slug?: string | undefined; /** *A JSON string containing input parameters for the view.
* @public */ InputData?: string | undefined; } /** * @public */ export interface UpdateWorkspacePageResponse { } /** * @public */ export interface UpdateWorkspaceThemeRequest { /** *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 theme configuration, including color schemes and visual styles.
* @public */ Theme?: WorkspaceTheme | undefined; } /** * @public */ export interface UpdateWorkspaceThemeResponse { } /** * @public */ export interface UpdateWorkspaceVisibilityRequest { /** *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 visibility setting for the workspace. Valid values are: ALL (available to all users),
* ASSIGNED (available only to assigned users and routing profiles), and NONE (not visible to
* any users).
A condition for item enablement.
* @public */ export interface EvaluationFormItemEnablementCondition { /** *Operands of the enablement condition.
* @public */ Operands: EvaluationFormItemEnablementConditionOperand[] | undefined; /** *The operator to be used to be applied to operands if more than one provided.
* @public */ Operator?: EvaluationFormItemEnablementOperator | undefined; } /** *An operand of the enablement condition.
* @public */ export type EvaluationFormItemEnablementConditionOperand = EvaluationFormItemEnablementConditionOperand.ConditionMember | EvaluationFormItemEnablementConditionOperand.ExpressionMember | EvaluationFormItemEnablementConditionOperand.$UnknownMember; /** * @public */ export declare namespace EvaluationFormItemEnablementConditionOperand { /** *An expression of the enablement condition.
* @public */ interface ExpressionMember { Expression: EvaluationFormItemEnablementExpression; Condition?: never; $unknown?: never; } /** *A condition for item enablement.
* @public */ interface ConditionMember { Expression?: never; Condition: EvaluationFormItemEnablementCondition; $unknown?: never; } /** * @public */ interface $UnknownMember { Expression?: never; Condition?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe search criteria to be used to return agent statuses.
* @public */ export interface AgentStatusSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description,
* state, type, displayOrder, and resourceID.
A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description,
* state, type, displayOrder, and resourceID.
The search criteria to be used to return flow modules.
* @public */ export interface ContactFlowModuleSearchCriteria { /** *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 string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *The state of the flow.
* @public */ StateCondition?: ContactFlowModuleState | undefined; /** *The status of the flow.
* @public */ StatusCondition?: ContactFlowModuleStatus | undefined; } /** *The search criteria to be used to return flows.
* @public */ export interface ContactFlowSearchCriteria { /** *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 string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *The type of flow.
* @public */ TypeCondition?: ContactFlowType | undefined; /** *The state of the flow.
* @public */ StateCondition?: ContactFlowState | undefined; /** *The status of the flow.
* @public */ StatusCondition?: ContactFlowStatus | undefined; } /** *A data table search criteria.
* @public */ export interface DataTableSearchCriteria { /** *The criteria's or conditions.
* @public */ OrConditions?: DataTableSearchCriteria[] | undefined; /** *The criteria's and conditions.
* @public */ AndConditions?: DataTableSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *The search criteria to be used to return email addresses.
* @public */ export interface EmailAddressSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: EmailAddressSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: EmailAddressSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *An item enablement configuration.
* @public */ export interface EvaluationFormItemEnablementConfiguration { /** *A condition for item enablement configuration.
* @public */ Condition: EvaluationFormItemEnablementCondition | undefined; /** *An enablement action that if condition is satisfied.
* @public */ Action: EvaluationFormItemEnablementAction | undefined; /** *An enablement action that if condition is not satisfied.
* @public */ DefaultAction?: EvaluationFormItemEnablementAction | undefined; } /** *The search criteria to be used to return evaluation forms.
* @public */ export interface EvaluationFormSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: EvaluationFormSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: EvaluationFormSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *A leaf node condition which can be used to specify a numeric condition.
*The currently supported value for FieldName is limit.
Boolean search condition.
* @public */ BooleanCondition?: BooleanCondition | undefined; /** *Datetime search condition.
* @public */ DateTimeCondition?: DateTimeCondition | undefined; } /** *The search criteria to be used to return evaluations.
* @public */ export interface EvaluationSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: EvaluationSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: EvaluationSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *A leaf node condition which can be used to specify a numeric condition.
*The currently supported value for FieldName is limit.
The boolean condition search criteria for searching evaluations.
* @public */ BooleanCondition?: BooleanCondition | undefined; /** *The datetime condition search criteria for searching evaluations.
* @public */ DateTimeCondition?: DateTimeCondition | undefined; /** *The decimal condition search criteria for searching evaluations.
* @public */ DecimalCondition?: DecimalCondition | undefined; } /** *A tagged union to specify expression for a routing step.
* @public */ export interface Expression { /** *An object to specify the predefined attribute condition.
* @public */ AttributeCondition?: AttributeCondition | undefined; /** *List of routing expressions which will be AND-ed together.
* @public */ AndExpression?: Expression[] | undefined; /** *List of routing expressions which will be OR-ed together.
* @public */ OrExpression?: Expression[] | undefined; /** *An object to specify the predefined attribute condition.
* @public */ NotAttributeCondition?: AttributeCondition | undefined; } /** *The search criteria to be used to return hours of operations overrides.
* @public */ export interface HoursOfOperationOverrideSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: HoursOfOperationOverrideSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *A leaf node condition which can be used to specify a date condition.
* @public */ DateCondition?: DateCondition | undefined; } /** *The search criteria to be used to return hours of operations.
* @public */ export interface HoursOfOperationSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: HoursOfOperationSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: HoursOfOperationSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description,
* timezone, and resourceID.
The search criteria to be used to return notifications.
* @public */ export interface NotificationSearchCriteria { /** *A list of conditions to be met, where at least one condition must be satisfied.
* @public */ OrConditions?: NotificationSearchCriteria[] | undefined; /** *A list of conditions that must all be satisfied.
* @public */ AndConditions?: NotificationSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *The search criteria to be used to return predefined attributes.
* @public */ export interface PredefinedAttributeSearchCriteria { /** *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 string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *The search criteria to be used to return prompts.
* @public */ export interface PromptSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: PromptSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: PromptSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description, and
* resourceID.
The search criteria to be used to return queues.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: QueueSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: QueueSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description, and
* resourceID.
The type of queue.
* @public */ QueueTypeCondition?: SearchableQueueType | undefined; } /** *The search criteria to be used to return quick connects.
* @public */ export interface QuickConnectSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: QuickConnectSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: QuickConnectSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, description, and
* resourceID.
The search criteria to be used to return routing profiles.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: RoutingProfileSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: RoutingProfileSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are associatedQueueIds,
* name, description, and resourceID.
The search criteria to be used to return security profiles.
*The name field support "contains" queries with a minimum of 2 characters and maximum of 25
* characters. Any queries with character lengths outside of this range will throw invalid
* results.
A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: SecurityProfileSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: SecurityProfileSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *A value for a segment attribute. This is structured as a map where the key is valueString and the
* value is a string.
The value of a segment attribute.
* @public */ ValueString?: string | undefined; /** *The value of a segment attribute.
* @public */ ValueMap?: RecordThe value of a segment attribute.
* @public */ ValueInteger?: number | undefined; /** *The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined * attributes.
* @public */ ValueList?: SegmentAttributeValue[] | undefined; /** *The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined * attributes, not for user-defined attributes.
* @public */ ValueArn?: string | undefined; } /** *The search criteria to be used to return test cases.
* @public */ export interface TestCaseSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: TestCaseSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: TestCaseSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *The status of the test case.
* @public */ StatusCondition?: TestCaseStatus | undefined; } /** *The search criteria to be used to return userHierarchyGroup.
* @public */ export interface UserHierarchyGroupSearchCriteria { /** *A list of conditions which would be applied together with an OR condition.
* @public */ OrConditions?: UserHierarchyGroupSearchCriteria[] | undefined; /** *A list of conditions which would be applied together with an AND condition.
* @public */ AndConditions?: UserHierarchyGroupSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
*The currently supported values for FieldName are name, parentId,
* levelId, and resourceID.
The search criteria to be used to return users.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
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 string condition.
*The currently supported values for FieldName are Username, FirstName,
* LastName, RoutingProfileId, SecurityProfileId,
* resourceId.
A leaf node condition which can be used to specify a List condition to search users with attributes included in * Lists like Proficiencies.
* @public */ ListCondition?: ListCondition | undefined; /** *A leaf node condition which can be used to specify a hierarchy group condition.
* @public */ HierarchyGroupCondition?: HierarchyGroupCondition | undefined; } /** *Defines the search criteria for filtering views.
* @public */ export interface ViewSearchCriteria { /** *A list of conditions to be met, where at least one condition must be satisfied.
* @public */ OrConditions?: ViewSearchCriteria[] | undefined; /** *A list of conditions that must all be satisfied.
* @public */ AndConditions?: ViewSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; /** *A condition that filters views by their type.
* @public */ ViewTypeCondition?: ViewType | undefined; /** *A condition that filters views by their status.
* @public */ ViewStatusCondition?: ViewStatus | undefined; } /** *Defines the search criteria for filtering workspace associations.
* @public */ export interface WorkspaceAssociationSearchCriteria { /** *A list of conditions to be met, where at least one condition must be satisfied.
* @public */ OrConditions?: WorkspaceAssociationSearchCriteria[] | undefined; /** *A list of conditions that must all be satisfied.
* @public */ AndConditions?: WorkspaceAssociationSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *Defines the search criteria for filtering workspaces.
* @public */ export interface WorkspaceSearchCriteria { /** *A list of conditions to be met, where at least one condition must be satisfied.
* @public */ OrConditions?: WorkspaceSearchCriteria[] | undefined; /** *A list of conditions that must all be satisfied.
* @public */ AndConditions?: WorkspaceSearchCriteria[] | undefined; /** *A leaf node condition which can be used to specify a string condition.
* @public */ StringCondition?: StringCondition | undefined; } /** *Information about a question from an evaluation form.
* @public */ export interface EvaluationFormQuestion { /** *The title of the question.
* @public */ Title: string | undefined; /** *The instructions of the section.
* @public */ Instructions?: string | undefined; /** *The identifier of the question. An identifier must be unique within the evaluation form.
* @public */ RefId: string | undefined; /** *The flag to enable not applicable answers to the question.
* @public */ NotApplicableEnabled?: boolean | undefined; /** *The type of the question.
* @public */ QuestionType: EvaluationFormQuestionType | undefined; /** *The properties of the type of question. Text questions do not have to define question type properties.
* @public */ QuestionTypeProperties?: EvaluationFormQuestionTypeProperties | undefined; /** *A question conditional enablement.
* @public */ Enablement?: EvaluationFormItemEnablementConfiguration | undefined; /** *The scoring weight of the section.
* @public */ Weight?: number | undefined; } /** *Step defines the list of agents to be routed or route based on the agent requirements such as ProficiencyLevel, * Name, or Value.
* @public */ export interface RoutingCriteriaInputStep { /** *An object to specify the expiration of a routing step.
* @public */ Expiry?: RoutingCriteriaInputStepExpiry | undefined; /** *A tagged union to specify expression for a routing step.
* @public */ Expression?: Expression | undefined; } /** * @public */ export interface SearchAgentStatusesRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the 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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: AgentStatusSearchFilter | undefined; /** *The search criteria to be used to return agent statuses.
* @public */ SearchCriteria?: AgentStatusSearchCriteria | undefined; } /** * @public */ export interface SearchContactEvaluationsRequest { /** *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 search criteria to be used to return contact evaluations.
* @public */ SearchCriteria?: EvaluationSearchCriteria | undefined; /** *Filters to be applied to search results.
* @public */ SearchFilter?: EvaluationSearchFilter | undefined; } /** * @public */ export interface SearchContactFlowModulesRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: ContactFlowModuleSearchFilter | undefined; /** *The search criteria to be used to return flow modules.
*The name and description fields support "contains" queries with a minimum of 2
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
* invalid results.
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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: ContactFlowSearchFilter | undefined; /** *The search criteria to be used to return flows.
*The name and description fields support "contains" queries with a minimum of 2
* characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in
* invalid results.
The unique identifier for the Amazon Connect instance to search within.
* @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; /** *Optional filters to apply to the search results, such as tag-based filtering for attribute-based access * control.
* @public */ SearchFilter?: DataTableSearchFilter | undefined; /** *Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports * STARTS_WITH, CONTAINS, and EXACT comparison types.
* @public */ SearchCriteria?: DataTableSearchCriteria | undefined; } /** * @public */ export interface SearchEmailAddressesRequest { /** *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; /** *The search criteria to be used to return email addresses.
* @public */ SearchCriteria?: EmailAddressSearchCriteria | undefined; /** *Filters to be applied to search results.
* @public */ SearchFilter?: EmailAddressSearchFilter | undefined; } /** * @public */ export interface SearchEvaluationFormsRequest { /** *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 search criteria to be used to return evaluation forms.
* @public */ SearchCriteria?: EvaluationFormSearchCriteria | undefined; /** *Filters to be applied to search results.
* @public */ SearchFilter?: EvaluationFormSearchFilter | undefined; } /** * @public */ export interface SearchHoursOfOperationOverridesRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: HoursOfOperationSearchFilter | undefined; /** *The search criteria to be used to return hours of operations overrides.
* @public */ SearchCriteria?: HoursOfOperationOverrideSearchCriteria | undefined; } /** * @public */ export interface SearchHoursOfOperationsRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: HoursOfOperationSearchFilter | undefined; /** *The search criteria to be used to return hours of operations.
* @public */ SearchCriteria?: HoursOfOperationSearchCriteria | undefined; } /** * @public */ export interface SearchNotificationsRequest { /** *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; /** *Filters to apply to the search results, such as tag-based filters.
* @public */ SearchFilter?: NotificationSearchFilter | undefined; /** *The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS_WITH, CONTAINS, and EXACT.
* @public */ SearchCriteria?: NotificationSearchCriteria | undefined; } /** * @public */ export interface SearchPredefinedAttributesRequest { /** *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 search criteria to be used to return predefined attributes.
* @public */ SearchCriteria?: PredefinedAttributeSearchCriteria | undefined; } /** * @public */ export interface SearchPromptsRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: PromptSearchFilter | undefined; /** *The search criteria to be used to return prompts.
* @public */ SearchCriteria?: PromptSearchCriteria | undefined; } /** * @public */ export interface SearchQueuesRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: QueueSearchFilter | undefined; /** *The search criteria to be used to return queues.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: QuickConnectSearchFilter | undefined; /** *The search criteria to be used to return quick connects.
* @public */ SearchCriteria?: QuickConnectSearchCriteria | undefined; } /** * @public */ export interface SearchRoutingProfilesRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: RoutingProfileSearchFilter | undefined; /** *The search criteria to be used to return routing profiles.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
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 search criteria to be used to return security profiles.
*The name field support "contains" queries with a minimum of 2 characters and maximum of 25
* characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for FieldName: name
*
Filters to be applied to search results.
* @public */ SearchFilter?: SecurityProfilesSearchFilter | undefined; } /** * @public */ export interface SearchTestCasesRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: TestCaseSearchFilter | undefined; /** *The search criteria to be used to return test cases.
* @public */ SearchCriteria?: TestCaseSearchCriteria | undefined; } /** * @public */ export interface SearchUserHierarchyGroupsRequest { /** *The identifier of the Amazon Connect instance. You can find the instanceId in the 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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: UserHierarchyGroupSearchFilter | undefined; /** *The search criteria to be used to return UserHierarchyGroups.
* @public */ SearchCriteria?: UserHierarchyGroupSearchCriteria | undefined; } /** * @public */ export interface SearchUsersRequest { /** *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; /** *Filters to be applied to search results.
* @public */ SearchFilter?: UserSearchFilter | undefined; /** *The search criteria to be used to return users.
*The name and description fields support "contains" queries with
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
* outside of this range will throw invalid results.
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; /** *Filters to apply to the search, such as tag-based filters.
* @public */ SearchFilter?: ViewSearchFilter | undefined; /** *The search criteria, including field names and comparison types.
* @public */ SearchCriteria?: ViewSearchCriteria | undefined; } /** * @public */ export interface SearchWorkspaceAssociationsRequest { /** *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; /** *Filters to apply to the search, such as tag-based filters.
* @public */ SearchFilter?: WorkspaceAssociationSearchFilter | undefined; /** *The search criteria, including workspace ID, resource ID, or resource type.
* @public */ SearchCriteria?: WorkspaceAssociationSearchCriteria | undefined; } /** * @public */ export interface SearchWorkspacesRequest { /** *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; /** *Filters to apply to the search, such as tag-based filters.
* @public */ SearchFilter?: WorkspaceSearchFilter | undefined; /** *The search criteria, including field names and comparison types.
* @public */ SearchCriteria?: WorkspaceSearchCriteria | undefined; } /** *Step signifies the criteria to be used for routing to an agent
* @public */ export interface Step { /** *An object to specify the expiration of a routing step.
* @public */ Expiry?: Expiry | undefined; /** *A tagged union to specify expression for a routing step.
* @public */ Expression?: Expression | undefined; /** *Represents status of the Routing step.
* @public */ Status?: RoutingCriteriaStepStatus | undefined; } /** *The value of a segment attribute. This is structured as a map with a single key-value pair. The key * 'valueString' indicates that the attribute type is a string, and its corresponding value is the actual string value * of the segment attribute.
* @public */ export interface ContactSearchSummarySegmentAttributeValue { /** *The value of a segment attribute represented as a string.
* @public */ ValueString?: string | undefined; /** *The key and value of a segment attribute.
* @public */ ValueMap?: RecordThe identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *A unique, 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 identifier of the contact in this instance of Amazon Connect.
* @public */ RelatedContactId?: string | undefined; /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordA formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
* reference types at the time of creation: URL | NUMBER | STRING |
* DATE | EMAIL | ATTACHMENT.
The channel for the contact.
*The CHAT channel is not supported. The following information is incorrect. We're working to correct it.
*Indicates how the contact was initiated.
*CreateContact only supports the following initiation methods. Valid values by channel are:
*For VOICE: TRANSFER and the subtype connect:ExternalAudio
*
For EMAIL: OUTBOUND | AGENT_REPLY | FLOW
*
For TASK: API
*
The other channels listed below are incorrect. We're working to correct this information.
*Number of minutes the contact will be active for before expiring
* @public */ ExpiryDurationInMinutes?: number | undefined; /** *User details for the contact
*UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY
* contact initiation methods.
Initial state of the contact when it's created. Only TASK channel contacts can be initiated with
* COMPLETED state.
The name of a the contact.
* @public */ Name?: string | undefined; /** *A description of the contact.
* @public */ Description?: string | undefined; /** *A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
*This field can be used to set Segment Contact Expiry as a duration in minutes.
*To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
* be active for before expiring, with SegmentAttributes like \{ "connect:ContactExpiry":
* \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}.
The ID of the previous contact when creating a transfer contact. This value can be provided only for external * audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice * systems in the Amazon Connect Administrator Guide.
* @public */ PreviousContactId?: string | undefined; } /** * @public */ export interface StartChatContactRequest { /** *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 for initiating the chat. * To * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here * in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx *
* @public */ ContactFlowId: string | undefined; /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordInformation identifying the participant.
* @public */ ParticipantDetails: ParticipantDetails | undefined; /** *The configuration of the participant.
* @public */ ParticipantConfiguration?: ParticipantConfiguration | undefined; /** *The initial message to be sent to the newly created chat.
* @public */ InitialMessage?: ChatMessage | 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 total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 * hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
* @public */ ChatDurationInMinutes?: number | undefined; /** *The supported chat message content types. Supported types are text/plain,
* text/markdown, application/json,
* application/vnd.amazonaws.connect.message.interactive, and
* application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the
* list. For example, all the following lists are valid because they contain text/plain: [text/plain,
* text/markdown, application/json], [text/markdown, text/plain], [text/plain,
* application/json, application/vnd.amazonaws.connect.message.interactive.response].
The type application/vnd.amazonaws.connect.message.interactive is required to use the Show view flow block.
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how * to configure for them, see Enable * persistent chat.
* @public */ PersistentChat?: PersistentChat | undefined; /** *The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
*You cannot provide data for both RelatedContactId and PersistentChat.
*A set of system defined key-value pairs stored on individual contact segments using an attribute map. The * attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
*This field can be used to show channel subtype, such as connect:Guide.
The types application/vnd.amazonaws.connect.message.interactive and
* application/vnd.amazonaws.connect.message.interactive.response must be present in the
* SupportedMessagingContentTypes field of this API in order to set SegmentAttributes as \{
* "connect:Subtype": \{"valueString" : "connect:Guide" \}\}.
The customer's identification number. For example, the CustomerId may be a customer number from
* your CRM.
A list of participant types to automatically disconnect when the end customer ends the chat session, allowing them to continue through disconnect flows such as surveys or feedback forms.
* @public */ DisconnectOnCustomerExit?: DisconnectOnCustomerExitParticipantType[] | undefined; } /** * @public */ export interface StartEmailContactRequest { /** *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 email address of the customer.
* @public */ FromEmailAddress: EmailAddressInfo | undefined; /** *The email address associated with the Amazon Connect instance.
* @public */ DestinationEmailAddress: string | undefined; /** *A description of the email contact.
* @public */ Description?: string | undefined; /** *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following
* reference types at the time of creation: URL | NUMBER | STRING |
* DATE. EMAIL | EMAIL_MESSAGE |ATTACHMENT are not a supported
* reference type during email creation.
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
* @public */ Name?: string | undefined; /** *The email message body to be sent to the newly created email.
* @public */ EmailMessage: InboundEmailContent | undefined; /** *The additional recipients address of the email.
* @public */ AdditionalRecipients?: InboundAdditionalRecipients | undefined; /** *List of S3 presigned URLs of email attachments and their file name.
* @public */ Attachments?: EmailAttachment[] | undefined; /** *The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation * menu go to Routing, Flows. Choose the flow. On the * flow page, under the name of the flow, choose Show additional flow information. The * ContactFlowId is the last part of the ARN, shown here in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx *
* @public */ ContactFlowId?: string | undefined; /** *The contactId that is related to this contact. Linking emails together by using RelatedContactID
* copies over contact attributes from the related email contact to the new email contact. All updates to user-defined
* attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of
* contacts that can be linked by using RelatedContactId.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordA set of system defined key-value pairs stored on individual contact segments using an attribute map. The * attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
*This field can be used to show channel subtype, such as connect:Guide.
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the
* contact will be active for before expiring, with SegmentAttributes like \{
* "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}.
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 StartOutboundChatContactRequest { /** *Information about the endpoint.
* @public */ SourceEndpoint: Endpoint | undefined; /** *Information about the endpoint.
* @public */ DestinationEndpoint: Endpoint | 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; /** *A set of system defined key-value pairs stored on individual contact segments using an attribute map. The * attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:SMS and
* connect:WhatsApp.
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
* @public */ Attributes?: RecordThe identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user * interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On * the flow page, under the name of the flow, choose Show additional flow information. * The ContactFlowId is the last part of the ARN, shown here in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx *
*The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 * hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
* @public */ ChatDurationInMinutes?: number | undefined; /** *The customer's details.
* @public */ ParticipantDetails?: ParticipantDetails | undefined; /** *A chat message.
* @public */ InitialSystemMessage?: ChatMessage | undefined; /** *Information about template message configuration.
* @public */ InitialTemplatedSystemMessage?: TemplatedMessageConfig | undefined; /** *The unique identifier for an Amazon Connect contact. This identifier is related to the contact * starting.
* @public */ RelatedContactId?: string | undefined; /** *The supported chat message content types. Supported types are:
*
* text/plain
*
* text/markdown
*
* application/json, application/vnd.amazonaws.connect.message.interactive
*
* application/vnd.amazonaws.connect.message.interactive.response
*
Content types must always contain text/plain. You can then put any other supported type in the
* list. For example, all the following lists are valid because they contain text/plain:
* [text/plain, text/markdown, application/json]
*
* [text/markdown, text/plain]
*
* [text/plain, application/json,
* application/vnd.amazonaws.connect.message.interactive.response]
*
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. The token is valid for 7 days after creation. If a contact is already started, the contact * ID is returned.
* @public */ ClientToken?: string | undefined; } /** * @public */ export interface StartTaskContactRequest { /** *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 previous chat, voice, or task contact. Any updates to user-defined attributes to task
* contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a
* maximum of 12 linked task contacts in a chain.
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation * menu go to Routing, Flows. Choose the flow. On the * flow page, under the name of the flow, choose Show additional flow information. The * ContactFlowId is the last part of the ARN, shown here in bold:
*arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx *
* @public */ ContactFlowId?: string | undefined; /** *A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and * can be accessed in flows just like any other contact attributes.
*There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only * alphanumeric, dash, and underscore characters.
* @public */ Attributes?: RecordThe name of a task that is shown to an agent in the Contact Control Panel (CCP).
* @public */ Name: string | undefined; /** *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following
* reference types at the time of creation: URL | NUMBER | STRING |
* DATE | EMAIL. ATTACHMENT is not a supported reference type during task
* creation.
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
* @public */ Description?: 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 timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
* @public */ ScheduledTime?: Date | undefined; /** *A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
* @public */ TaskTemplateId?: string | undefined; /** *The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined
* on agent or queue quick connect. For more information about quick connects, see Create quick connects.
The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact
* attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new
* task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using
* PreviousContactID. There are no limits to the number of contacts that can be linked by using
* RelatedContactId.
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
*This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created * a task.
*To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will
* be active for before expiring, with SegmentAttributes like \{ "connect:ContactExpiry":
* \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger": 135\}\}\}\}.
To set the created by user, a valid AgentResourceId must be supplied, with SegmentAttributes like
* \{ "connect:CreatedByUser" \{ "ValueString":
* "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}.
*
List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.
* @public */ Attachments?: TaskAttachment[] | undefined; } /** * @public */ export interface UpdateContactRequest { /** *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. This is the identifier of the contact associated with the first interaction with * your contact center.
* @public */ ContactId: string | undefined; /** *The name of the contact.
* @public */ Name?: string | undefined; /** *The description of the contact.
* @public */ Description?: string | undefined; /** *Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
* @public */ References?: RecordA set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
*Attribute keys can include only alphanumeric, -, and _.
*This field can be used to show channel subtype, such as connect:Guide.
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be * updated by using the UpdateContact API.
* @public */ SegmentAttributes?: RecordInformation about the queue associated with a contact. This parameter can only be updated for external audio * contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in * the * Amazon Connect Administrator Guide.
* @public */ QueueInfo?: QueueInfoInput | undefined; /** *Information about the agent associated with a contact. This parameter can only be updated for external audio * contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in * the * Amazon Connect Administrator Guide.
* @public */ UserInfo?: UserInfo | undefined; /** *The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually * the end customer's phone number. This value can only be updated for external audio contacts. For more information, * see Amazon Connect * Contact Lens integration in the Amazon Connect Administrator Guide.
* @public */ CustomerEndpoint?: Endpoint | undefined; /** *External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of * the external system such as the contact center. This value can only be updated for external audio contacts. For more * information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator * Guide.
* @public */ SystemEndpoint?: Endpoint | undefined; } /** *Information about an item from an evaluation form. The item must be either a section or a question.
* @public */ export type EvaluationFormItem = EvaluationFormItem.QuestionMember | EvaluationFormItem.SectionMember | EvaluationFormItem.$UnknownMember; /** * @public */ export declare namespace EvaluationFormItem { /** *The information of the section.
* @public */ interface SectionMember { Section: EvaluationFormSection; Question?: never; $unknown?: never; } /** *The information of the question.
* @public */ interface QuestionMember { Section?: never; Question: EvaluationFormQuestion; $unknown?: never; } /** * @public */ interface $UnknownMember { Section?: never; Question?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorLatest routing criteria on the contact.
* @public */ export interface RoutingCriteria { /** *List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a * step for a given step duration, the routing criteria will move on to the next step sequentially until a join is * completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
* @public */ Steps?: Step[] | undefined; /** *The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when * contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue * even though Routing criteria is never activated for contacts in agent queue.
* @public */ ActivationTimestamp?: Date | undefined; /** *Information about the index of the routing criteria.
* @public */ Index?: number | undefined; } /** *An object to define the RoutingCriteria.
* @public */ export interface RoutingCriteriaInput { /** *When Amazon Connect does not find an available agent meeting the requirements in a step for a given step * duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. * When all steps are exhausted, the contact will be offered to any agent in the queue.
* @public */ Steps?: RoutingCriteriaInputStep[] | undefined; } /** *Information about a section from an evaluation form. A section can contain sections and/or questions. Evaluation * forms can only contain sections and subsections (two level nesting).
* @public */ export interface EvaluationFormSection { /** *The title of the section.
* @public */ Title: string | undefined; /** *The identifier of the section. An identifier must be unique within the evaluation form.
* @public */ RefId: string | undefined; /** *The instructions of the section.
* @public */ Instructions?: string | undefined; /** *The items of the section.
* @public */ Items: EvaluationFormItem[] | undefined; /** *The scoring weight of the section.
* @public */ Weight?: number | undefined; } /** * @public */ export interface CreateEvaluationFormRequest { /** *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 title of the evaluation form.
* @public */ Title: string | undefined; /** *The description of the evaluation form.
* @public */ Description?: string | undefined; /** *Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
* @public */ Items: EvaluationFormItem[] | undefined; /** *A scoring strategy of the evaluation form.
* @public */ ScoringStrategy?: EvaluationFormScoringStrategy | undefined; /** *Configuration information about automated evaluations.
* @public */ AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | 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; /** *A boolean flag indicating whether to create evaluation form in draft state.
* @public */ AsDraft?: boolean | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordConfiguration information about evaluation reviews.
* @public */ ReviewConfiguration?: EvaluationReviewConfiguration | undefined; /** *Configuration that specifies the target for the evaluation form.
* @public */ TargetConfiguration?: EvaluationFormTargetConfiguration | undefined; /** *Configuration for language settings of the evaluation form.
* @public */ LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined; } /** *Information about the evaluation form.
* @public */ export interface EvaluationForm { /** *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 Amazon Resource Name (ARN) for the evaluation form resource.
* @public */ EvaluationFormArn: string | undefined; /** *A title of the evaluation form.
* @public */ Title: string | undefined; /** *The description of the evaluation form.
* @public */ Description?: string | undefined; /** *The status of the evaluation form.
* @public */ Status: EvaluationFormVersionStatus | undefined; /** *Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
* @public */ Items: EvaluationFormItem[] | undefined; /** *A scoring strategy of the evaluation form.
* @public */ ScoringStrategy?: EvaluationFormScoringStrategy | 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 automatic evaluation configuration of an evaluation form.
* @public */ AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined; /** *Configuration for evaluation review settings of this evaluation form.
* @public */ ReviewConfiguration?: EvaluationReviewConfiguration | undefined; /** *The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.
* @public */ Tags?: RecordConfiguration that specifies the target for this evaluation form.
* @public */ TargetConfiguration?: EvaluationFormTargetConfiguration | undefined; /** *Configuration for language settings of this evaluation form.
* @public */ LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined; } /** *Information about an evaluation form used in a contact evaluation.
* @public */ export interface EvaluationFormContent { /** *A version of the evaluation form.
* @public */ EvaluationFormVersion: number | undefined; /** *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 description of the evaluation form.
* @public */ Description?: string | undefined; /** *Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
* @public */ Items: EvaluationFormItem[] | undefined; /** *A scoring strategy of the evaluation form.
* @public */ ScoringStrategy?: EvaluationFormScoringStrategy | undefined; /** *The configuration of the automated evaluation.
* @public */ AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined; /** *Configuration that specifies the target for this evaluation form content.
* @public */ TargetConfiguration?: EvaluationFormTargetConfiguration | undefined; /** *Configuration for language settings of this evaluation form content.
* @public */ LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined; /** *Configuration for evaluation review settings of this evaluation form content.
* @public */ ReviewConfiguration?: EvaluationReviewConfiguration | undefined; } /** * @public */ export interface UpdateContactRoutingDataRequest { /** *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 number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a * first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes * their position in queue.
* @public */ QueueTimeAdjustmentSeconds?: number | undefined; /** *Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of * a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.
* @public */ QueuePriority?: number | undefined; /** *Updates the routing criteria on the contact. These properties can be used to change how a contact is routed * within the queue.
* @public */ RoutingCriteria?: RoutingCriteriaInput | undefined; } /** * @public */ export interface UpdateEvaluationFormRequest { /** *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
* @public */ InstanceId: string | undefined; /** *The unique identifier for the evaluation form.
* @public */ EvaluationFormId: string | undefined; /** *A version of the evaluation form to update.
* @public */ EvaluationFormVersion: number | undefined; /** *A flag indicating whether the operation must create a new version.
* @public */ CreateNewVersion?: boolean | undefined; /** *A title of the evaluation form.
* @public */ Title: string | undefined; /** *The description of the evaluation form.
* @public */ Description?: string | undefined; /** *Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
* @public */ Items: EvaluationFormItem[] | undefined; /** *A scoring strategy of the evaluation form.
* @public */ ScoringStrategy?: EvaluationFormScoringStrategy | undefined; /** *Whether automated evaluations are enabled.
* @public */ AutoEvaluationConfiguration?: EvaluationFormAutoEvaluationConfiguration | undefined; /** *Configuration for evaluation review settings of the evaluation form.
* @public */ ReviewConfiguration?: EvaluationReviewConfiguration | undefined; /** *A boolean flag indicating whether to update evaluation form to draft state.
* @public */ AsDraft?: boolean | 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; /** *Configuration that specifies the target for the evaluation form.
* @public */ TargetConfiguration?: EvaluationFormTargetConfiguration | undefined; /** *Configuration for language settings of the evaluation form.
* @public */ LanguageConfiguration?: EvaluationFormLanguageConfiguration | undefined; } /** * @public */ export interface DescribeContactEvaluationResponse { /** *Information about the evaluation form completed for a specific contact.
* @public */ Evaluation: Evaluation | undefined; /** *Information about the evaluation form.
* @public */ EvaluationForm: EvaluationFormContent | undefined; } /** * @public */ export interface DescribeEvaluationFormResponse { /** *Information about the evaluation form.
* @public */ EvaluationForm: EvaluationForm | undefined; } /** *Contains information about a contact.
* @public */ export interface Contact { /** *The Amazon Resource Name (ARN) for the contact.
* @public */ Arn?: string | undefined; /** *The identifier for the contact.
* @public */ Id?: string | 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; /** *This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact * tree.
* @public */ ContactAssociationId?: string | undefined; /** *Indicates how the contact was initiated.
* @public */ InitiationMethod?: ContactInitiationMethod | undefined; /** *The name of the contact.
* @public */ Name?: string | undefined; /** *The description of the contact.
* @public */ Description?: string | undefined; /** *How the contact reached your contact center.
* @public */ Channel?: Channel | undefined; /** *If this contact was queued, this contains information about the queue.
* @public */ QueueInfo?: QueueInfo | undefined; /** *Information about the agent who accepted the contact.
* @public */ AgentInfo?: AgentInfo | undefined; /** *The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact
* arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the
* callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer
* was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is
* when the agent started dialing the external participant. For MONITOR, this is when the supervisor
* started listening to a contact.
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; /** *The timestamp when contact was last updated.
* @public */ LastUpdateTimestamp?: Date | undefined; /** *The timestamp when the contact was last paused.
* @public */ LastPausedTimestamp?: Date | undefined; /** *The timestamp when the contact was last resumed.
* @public */ LastResumedTimestamp?: Date | undefined; /** *The timestamp when ringing started for a campaign call.
* @public */ RingStartTimestamp?: Date | undefined; /** *Total pause count for a contact.
* @public */ TotalPauseCount?: number | undefined; /** *Total pause duration for a contact in seconds.
* @public */ TotalPauseDurationInSeconds?: number | undefined; /** *The timestamp, in Unix epoch time format, at which to start running the inbound flow.
* @public */ ScheduledTimestamp?: Date | undefined; /** *The contactId that is related to this contact.
* @public */ RelatedContactId?: string | undefined; /** *Information about Amazon Connect Wisdom.
* @public */ WisdomInfo?: WisdomInfo | undefined; /** *The customer's identification number. For example, the CustomerId may be a customer number from
* your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you
* enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of
* the caller.
The customer or external third party participant endpoint.
* @public */ CustomerEndpoint?: EndpointInfo | undefined; /** *The system endpoint. For INBOUND, this is the phone number or email address that the customer
* dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned
* to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled
* by agents with softphone.
An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue * time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined * and a valid integer value.
* @public */ QueueTimeAdjustmentSeconds?: number | undefined; /** *An integer that represents the queue priority to be applied to the contact (lower priorities are routed * preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must * be larger than zero, and a valid integer value. Default Value is 5.
* @public */ QueuePriority?: number | undefined; /** *Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
* @public */ Tags?: RecordThe timestamp when customer endpoint connected to Amazon Connect.
* @public */ ConnectedToSystemTimestamp?: Date | undefined; /** *Latest routing criteria on the contact.
* @public */ RoutingCriteria?: RoutingCriteria | undefined; /** *Information about the Customer on the contact.
* @public */ Customer?: Customer | undefined; /** *Information associated with a campaign.
* @public */ Campaign?: Campaign | undefined; /** *Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
* @public */ AnsweringMachineDetectionStatus?: AnsweringMachineDetectionStatus | undefined; /** *Information about customer’s voice activity.
* @public */ CustomerVoiceActivity?: CustomerVoiceActivity | undefined; /** *Information about the quality of the participant's media connection.
* @public */ QualityMetrics?: QualityMetrics | undefined; /** *Information about how agent, bot, and customer interact in a chat contact.
* @public */ ChatMetrics?: ChatMetrics | undefined; /** *Information about the call disconnect experience.
* @public */ DisconnectDetails?: DisconnectDetails | undefined; /** *List of additional email addresses for an email contact.
* @public */ AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined; /** *A set of system defined key-value pairs stored on individual contact segments using an attribute map. The
* attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only
* alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example,
* connect:Guide or connect:SMS.
If recording was enabled, this is information about the recordings.
* @public */ Recordings?: RecordingInfo[] | undefined; /** *The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by * channel, see DisconnectReason under ContactTraceRecord in the * Amazon Connect Administrator Guide.
* @public */ DisconnectReason?: string | undefined; /** *Information about the contact evaluations where the key is the FormId, which is a unique identifier for the * form.
* @public */ ContactEvaluations?: RecordIf this contact was created using a task template, this contains information about the task template.
* @public */ TaskTemplateInfo?: TaskTemplateInfoV2 | undefined; /** *A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. * This object is used only for task contacts.
* @public */ ContactDetails?: ContactDetails | undefined; /** *Information about the outbound strategy.
* @public */ OutboundStrategy?: OutboundStrategy | undefined; /** *The attributes of the contact.
* @public */ Attributes?: RecordList of next contact entries for the contact.
* @public */ NextContacts?: NextContactEntry[] | undefined; /** *Information about the global resiliency configuration for the contact, including traffic distribution details.
* @public */ GlobalResiliencyMetadata?: GlobalResiliencyMetadata | undefined; } /** *Information of returned contact.
* @public */ export interface ContactSearchSummary { /** *The Amazon Resource Name (ARN) of the contact.
* @public */ Arn?: string | undefined; /** *The identifier of the contact summary.
* @public */ Id?: string | 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; /** *Indicates how the contact was initiated.
* @public */ InitiationMethod?: ContactInitiationMethod | undefined; /** *How the contact reached your contact center.
* @public */ Channel?: Channel | undefined; /** *If this contact was queued, this contains information about the queue.
* @public */ QueueInfo?: ContactSearchSummaryQueueInfo | undefined; /** *Information about the agent who accepted the contact.
* @public */ AgentInfo?: ContactSearchSummaryAgentInfo | undefined; /** *The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact
* arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the
* callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer
* was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent
* started dialing the external participant. For MONITOR, this is when the supervisor started listening to
* a contact.
The timestamp when the customer endpoint disconnected from Amazon Connect.
* @public */ DisconnectTimestamp?: Date | undefined; /** *The timestamp, in Unix epoch time format, at which to start running the inbound flow.
* @public */ ScheduledTimestamp?: Date | undefined; /** *Set of segment attributes for a contact.
* @public */ SegmentAttributes?: RecordIndicates name of the contact.
* @public */ Name?: string | undefined; /** *Latest routing criteria on the contact.
* @public */ RoutingCriteria?: RoutingCriteria | undefined; /** *Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
* @public */ Tags?: RecordAdditional routing information for contacts created in ACGR instances.
* @public */ GlobalResiliencyMetadata?: GlobalResiliencyMetadata | undefined; } /** * @public */ export interface DescribeContactResponse { /** *Information about the contact.
* @public */ Contact?: Contact | undefined; } /** * @public */ export interface SearchContactsResponse { /** *Information about the contacts.
* @public */ Contacts: ContactSearchSummary[] | undefined; /** *If there are additional results, this is the token for the next set of results.
* @public */ NextToken?: string | undefined; /** *The total number of contacts which matched your search query.
* @public */ TotalCount?: number | undefined; }