@aws-sdk/client-qconnect 3.1134.0 → 3.1136.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +88 -18
  3. package/dist-es/models/enums.js +11 -0
  4. package/dist-es/schemas/schemas_0.js +70 -17
  5. package/dist-types/QConnect.d.ts +1 -1
  6. package/dist-types/QConnectClient.d.ts +1 -1
  7. package/dist-types/commands/CreateAIAgentCommand.d.ts +74 -2
  8. package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +37 -1
  9. package/dist-types/commands/CreateContentAssociationCommand.d.ts +1 -1
  10. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +2 -1
  11. package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -2
  12. package/dist-types/commands/CreateSessionCommand.d.ts +1 -1
  13. package/dist-types/commands/DeleteContentAssociationCommand.d.ts +1 -1
  14. package/dist-types/commands/GetAIAgentCommand.d.ts +37 -1
  15. package/dist-types/commands/GetContentAssociationCommand.d.ts +1 -1
  16. package/dist-types/commands/GetNextMessageCommand.d.ts +1 -0
  17. package/dist-types/commands/GetRecommendationsCommand.d.ts +1 -1
  18. package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +37 -1
  19. package/dist-types/commands/ListAIAgentsCommand.d.ts +37 -1
  20. package/dist-types/commands/ListContentAssociationsCommand.d.ts +1 -1
  21. package/dist-types/commands/ListMessagesCommand.d.ts +1 -0
  22. package/dist-types/commands/ListSpansCommand.d.ts +3 -0
  23. package/dist-types/commands/QueryAssistantCommand.d.ts +1 -1
  24. package/dist-types/commands/SendMessageCommand.d.ts +1 -0
  25. package/dist-types/commands/UpdateAIAgentCommand.d.ts +74 -2
  26. package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
  27. package/dist-types/index.d.ts +1 -1
  28. package/dist-types/models/enums.d.ts +27 -0
  29. package/dist-types/models/models_0.d.ts +187 -267
  30. package/dist-types/models/models_1.d.ts +279 -7
  31. package/dist-types/schemas/schemas_0.d.ts +5 -0
  32. package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +2 -4
  33. package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +1 -2
  34. package/dist-types/ts3.4/models/enums.d.ts +13 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +81 -76
  36. package/dist-types/ts3.4/models/models_1.d.ts +81 -3
  37. package/dist-types/ts3.4/schemas/schemas_0.d.ts +5 -0
  38. package/package.json +1 -1
@@ -56,6 +56,51 @@ export interface AgentAttributes {
56
56
  */
57
57
  lastName?: string | undefined;
58
58
  }
59
+ /**
60
+ * <p>A union that identifies a collaborator agent to engage. Specify either an Amazon Connect AI Agent or a third-party agent.</p>
61
+ * @public
62
+ */
63
+ export type AgentTarget = AgentTarget.AiAgentIdMember | AgentTarget.ApplicationIdMember | AgentTarget.$UnknownMember;
64
+ /**
65
+ * @public
66
+ */
67
+ export declare namespace AgentTarget {
68
+ /**
69
+ * <p>The identifier of an Amazon Connect AI Agent to use as the collaborator agent.</p>
70
+ * @public
71
+ */
72
+ interface AiAgentIdMember {
73
+ aiAgentId: string;
74
+ applicationId?: never;
75
+ $unknown?: never;
76
+ }
77
+ /**
78
+ * <p>The identifier of a third-party agent to use as the collaborator agent.</p>
79
+ * @public
80
+ */
81
+ interface ApplicationIdMember {
82
+ aiAgentId?: never;
83
+ applicationId: string;
84
+ $unknown?: never;
85
+ }
86
+ /**
87
+ * @public
88
+ */
89
+ interface $UnknownMember {
90
+ aiAgentId?: never;
91
+ applicationId?: never;
92
+ $unknown: [string, any];
93
+ }
94
+ /**
95
+ * @deprecated unused in schema-serde mode.
96
+ *
97
+ */
98
+ interface Visitor<T> {
99
+ aiAgentId: (value: string) => T;
100
+ applicationId: (value: string) => T;
101
+ _: (name: string, value: any) => T;
102
+ }
103
+ }
59
104
  /**
60
105
  * <p>A leaf node condition which can be used to specify a tag condition. </p>
61
106
  * @public
@@ -428,6 +473,109 @@ export interface NoteTakingAIAgentConfiguration {
428
473
  */
429
474
  locale?: string | undefined;
430
475
  }
476
+ /**
477
+ * <p>The instruction that guides how the Orchestration AI Agent works with a collaborator agent.</p>
478
+ * @public
479
+ */
480
+ export interface MultiAgentInstruction {
481
+ /**
482
+ * <p>The natural-language instruction that tells the Orchestration AI Agent when and how to engage the collaborator agent.</p>
483
+ * @public
484
+ */
485
+ instruction?: string | undefined;
486
+ /**
487
+ * <p>Example interactions that illustrate when the Orchestration AI Agent should engage the collaborator agent.</p>
488
+ * @public
489
+ */
490
+ examples?: string[] | undefined;
491
+ }
492
+ /**
493
+ * <p>A collaborator agent configuration in which the Orchestration AI Agent invokes the collaborator, resuming when the collaborator returns.</p>
494
+ * @public
495
+ */
496
+ export interface DelegateAgentConfiguration {
497
+ /**
498
+ * <p>The collaborator agent to delegate to.</p>
499
+ * @public
500
+ */
501
+ agentTarget: AgentTarget | undefined;
502
+ /**
503
+ * <p>The instruction that tells the Orchestration AI Agent when and how to delegate to this collaborator agent.</p>
504
+ * @public
505
+ */
506
+ instruction?: MultiAgentInstruction | undefined;
507
+ }
508
+ /**
509
+ * <p>A collaborator agent configuration in which the Orchestration AI Agent transfers control of the conversation to the collaborator agent.</p>
510
+ * @public
511
+ */
512
+ export interface HandoffAgentConfiguration {
513
+ /**
514
+ * <p>The collaborator agent to hand off to.</p>
515
+ * @public
516
+ */
517
+ agentTarget: AgentTarget | undefined;
518
+ /**
519
+ * <p>The instruction that tells the Orchestration AI Agent when and how to hand off to this collaborator agent.</p>
520
+ * @public
521
+ */
522
+ instruction?: MultiAgentInstruction | undefined;
523
+ /**
524
+ * <p>Specifies whether the caller's audio is streamed directly to the collaborator agent and the collaborator's audio response is played back during the handoff. This applies only to voice handoffs.</p>
525
+ * @public
526
+ */
527
+ audioStreamingEnabled?: boolean | undefined;
528
+ /**
529
+ * <p>Specifies whether the conversation is handed off to this collaborator agent immediately on the first turn, without any orchestration reasoning. At most one handoff in an AI Agent's configuration can set this to <code>true</code>.</p>
530
+ * @public
531
+ */
532
+ immediateHandoff?: boolean | undefined;
533
+ }
534
+ /**
535
+ * <p>A union that configures a single collaborator agent for an Orchestration AI Agent, as either a delegate or a handoff.</p>
536
+ * @public
537
+ */
538
+ export type MultiAgentConfiguration = MultiAgentConfiguration.DelegateAgentConfigurationMember | MultiAgentConfiguration.HandoffAgentConfigurationMember | MultiAgentConfiguration.$UnknownMember;
539
+ /**
540
+ * @public
541
+ */
542
+ export declare namespace MultiAgentConfiguration {
543
+ /**
544
+ * <p>Configures the collaborator agent as a delegate that the Orchestration AI Agent invokes while retaining control of the conversation.</p>
545
+ * @public
546
+ */
547
+ interface DelegateAgentConfigurationMember {
548
+ delegateAgentConfiguration: DelegateAgentConfiguration;
549
+ handoffAgentConfiguration?: never;
550
+ $unknown?: never;
551
+ }
552
+ /**
553
+ * <p>Configures the collaborator agent as a handoff target that the Orchestration AI Agent transfers control of the conversation to.</p>
554
+ * @public
555
+ */
556
+ interface HandoffAgentConfigurationMember {
557
+ delegateAgentConfiguration?: never;
558
+ handoffAgentConfiguration: HandoffAgentConfiguration;
559
+ $unknown?: never;
560
+ }
561
+ /**
562
+ * @public
563
+ */
564
+ interface $UnknownMember {
565
+ delegateAgentConfiguration?: never;
566
+ handoffAgentConfiguration?: never;
567
+ $unknown: [string, any];
568
+ }
569
+ /**
570
+ * @deprecated unused in schema-serde mode.
571
+ *
572
+ */
573
+ interface Visitor<T> {
574
+ delegateAgentConfiguration: (value: DelegateAgentConfiguration) => T;
575
+ handoffAgentConfiguration: (value: HandoffAgentConfiguration) => T;
576
+ _: (name: string, value: any) => T;
577
+ }
578
+ }
431
579
  /**
432
580
  * <p>An annotation that provides additional context or metadata.</p>
433
581
  * @public
@@ -643,7 +791,7 @@ export interface OrchestrationAIAgentConfiguration {
643
791
  * <p>The AI Prompt identifier used by the Orchestration AI Agent.</p>
644
792
  * @public
645
793
  */
646
- orchestrationAIPromptId: string | undefined;
794
+ orchestrationAIPromptId?: string | undefined;
647
795
  /**
648
796
  * <p>The AI Guardrail identifier used by the Orchestration AI Agent.</p>
649
797
  * @public
@@ -654,6 +802,11 @@ export interface OrchestrationAIAgentConfiguration {
654
802
  * @public
655
803
  */
656
804
  toolConfigurations?: ToolConfiguration[] | undefined;
805
+ /**
806
+ * <p>The collaborator agents that the Orchestration AI Agent can work with. Each entry defines another agent that the orchestrator either delegates to or hands the conversation off to.</p>
807
+ * @public
808
+ */
809
+ multiAgentConfigurations?: MultiAgentConfiguration[] | undefined;
657
810
  /**
658
811
  * <p>The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.</p>
659
812
  * @public
@@ -664,6 +817,16 @@ export interface OrchestrationAIAgentConfiguration {
664
817
  * @public
665
818
  */
666
819
  locale?: string | undefined;
820
+ /**
821
+ * <p>The JSON schemas that define the structure of the structured data input accepted by the Orchestration AI Agent. The data in a <code>DATA</code> message sent to the agent is validated against these schemas. You can specify at most one schema.</p>
822
+ * @public
823
+ */
824
+ inputSchemas?: __DocumentType[] | undefined;
825
+ /**
826
+ * <p>The JSON schemas that define the structure of the structured output generated by the Orchestration AI Agent. You can specify at most one schema.</p>
827
+ * @public
828
+ */
829
+ outputSchemas?: __DocumentType[] | undefined;
667
830
  }
668
831
  /**
669
832
  * <p>The configuration for AI Agents of type SELF_SERVICE.</p>
@@ -1410,7 +1573,7 @@ export interface AIGuardrailContextualGroundingPolicyConfig {
1410
1573
  */
1411
1574
  export interface GuardrailPiiEntityConfig {
1412
1575
  /**
1413
- * <p>Configure AI Guardrail type when the PII entity is detected.</p> <p>The following PIIs are used to block or mask sensitive information:</p> <ul> <li> <p> <b>General</b> </p> <ul> <li> <p> <b>ADDRESS</b> </p> <p>A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. </p> </li> <li> <p> <b>AGE</b> </p> <p>An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. </p> </li> <li> <p> <b>NAME</b> </p> <p>An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. </p> </li> <li> <p> <b>EMAIL</b> </p> <p>An email address, such as <i>marymajor@email.com</i>.</p> </li> <li> <p> <b>PHONE</b> </p> <p>A phone number. This entity type also includes fax and pager numbers. </p> </li> <li> <p> <b>USERNAME</b> </p> <p>A user name that identifies an account, such as a login name, screen name, nick name, or handle. </p> </li> <li> <p> <b>PASSWORD</b> </p> <p>An alphanumeric string that is used as a password, such as "*<i> very20special#pass*</i>". </p> </li> <li> <p> <b>DRIVER_ID</b> </p> <p>The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. </p> </li> <li> <p> <b>LICENSE_PLATE</b> </p> <p>A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. </p> </li> <li> <p> <b>VEHICLE_IDENTIFICATION_NUMBER</b> </p> <p>A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the <i>ISO 3779</i> specification. Each country has specific codes and formats for VINs. </p> </li> </ul> </li> <li> <p> <b>Finance</b> </p> <ul> <li> <p> <b>CREDIT_DEBIT_CARD_CVV</b> </p> <p>A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_EXPIRY</b> </p> <p>The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as <i>month/year</i> or <i>MM/YY</i>. AI Guardrail recognizes expiration dates such as <i>01/21</i>, <i>01/2021</i>, and <i>Jan 2021</i>. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_NUMBER</b> </p> <p>The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. </p> </li> <li> <p> <b>PIN</b> </p> <p>A four-digit personal identification number (PIN) with which you can access your bank account. </p> </li> <li> <p> <b>INTERNATIONAL_BANK_ACCOUNT_NUMBER</b> </p> <p>An International Bank Account Number has specific formats in each country. For more information, see <a href="https://www.iban.com/structure"> www.iban.com/structure</a>.</p> </li> <li> <p> <b>SWIFT_CODE</b> </p> <p>A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.</p> <p>SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.</p> </li> </ul> </li> <li> <p> <b>IT</b> </p> <ul> <li> <p> <b>IP_ADDRESS</b> </p> <p>An IPv4 address, such as <i>198.51.100.0</i>. </p> </li> <li> <p> <b>MAC_ADDRESS</b> </p> <p>A <i>media access control</i> (MAC) address is a unique identifier assigned to a network interface controller (NIC). </p> </li> <li> <p> <b>URL</b> </p> <p>A web address, such as <i>www.example.com</i>. </p> </li> <li> <p> <b>AWS_ACCESS_KEY</b> </p> <p>A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> <li> <p> <b>AWS_SECRET_KEY</b> </p> <p>A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> </ul> </li> <li> <p> <b>USA specific</b> </p> <ul> <li> <p> <b>US_BANK_ACCOUNT_NUMBER</b> </p> <p>A US bank account number, which is typically 10 to 12 digits long. </p> </li> <li> <p> <b>US_BANK_ROUTING_NUMBER</b> </p> <p>A US bank account routing number. These are typically nine digits long, </p> </li> <li> <p> <b>US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER</b> </p> <p>A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. </p> </li> <li> <p> <b>US_PASSPORT_NUMBER</b> </p> <p>A US passport number. Passport numbers range from six to nine alphanumeric characters. </p> </li> <li> <p> <b>US_SOCIAL_SECURITY_NUMBER</b> </p> <p>A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. </p> </li> </ul> </li> <li> <p> <b>Canada specific</b> </p> <ul> <li> <p> <b>CA_HEALTH_NUMBER</b> </p> <p>A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. </p> </li> <li> <p> <b>CA_SOCIAL_INSURANCE_NUMBER</b> </p> <p>A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.</p> <p>The SIN is formatted as three groups of three digits, such as <i> 123-456-789</i>. A SIN can be validated through a simple check-digit process called the <a href="https://www.wikipedia.org/wiki/Luhn_algorithm">Luhn algorithm</a> .</p> </li> </ul> </li> <li> <p> <b>UK Specific</b> </p> <ul> <li> <p> <b>UK_NATIONAL_HEALTH_SERVICE_NUMBER</b> </p> <p>A UK National Health Service Number is a 10-17 digit number, such as <i>485 555 3456</i>. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.</p> </li> <li> <p> <b>UK_NATIONAL_INSURANCE_NUMBER</b> </p> <p>A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.</p> <p>The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.</p> </li> <li> <p> <b>UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER</b> </p> <p>A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. </p> </li> </ul> </li> <li> <p> <b>Custom</b> </p> <ul> <li> <p> <b>Regex filter</b> - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..</p> </li> </ul> </li> </ul>
1576
+ * <p>Configure AI Guardrail type when the PII entity is detected.</p> <p>The following PIIs are used to block or mask sensitive information:</p> <ul> <li> <p> <b>General</b> </p> <ul> <li> <p> <b>ADDRESS</b> </p> <p>A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. </p> </li> <li> <p> <b>AGE</b> </p> <p>An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age. </p> </li> <li> <p> <b>NAME</b> </p> <p>An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. </p> </li> <li> <p> <b>EMAIL</b> </p> <p>An email address, such as <i>marymajor@email.com</i>.</p> </li> <li> <p> <b>PHONE</b> </p> <p>A phone number. This entity type also includes fax and pager numbers. </p> </li> <li> <p> <b>USERNAME</b> </p> <p>A user name that identifies an account, such as a login name, screen name, nick name, or handle. </p> </li> <li> <p> <b>PASSWORD</b> </p> <p>An alphanumeric string that is used as a password, such as "*<i> very20special#pass*</i>". </p> </li> <li> <p> <b>DRIVER_ID</b> </p> <p>The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. </p> </li> <li> <p> <b>LICENSE_PLATE</b> </p> <p>A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. </p> </li> <li> <p> <b>VEHICLE_IDENTIFICATION_NUMBER</b> </p> <p>A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the <i>ISO 3779</i> specification. Each country has specific codes and formats for VINs. </p> </li> </ul> </li> <li> <p> <b>Finance</b> </p> <ul> <li> <p> <b>CREDIT_DEBIT_CARD_CVV</b> </p> <p>A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_EXPIRY</b> </p> <p>The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as <i>month/year</i> or <i>MM/YY</i>. AI Guardrail recognizes expiration dates such as <i>01/21</i>, <i>01/2021</i>, and <i>Jan 2021</i>. </p> </li> <li> <p> <b>CREDIT_DEBIT_CARD_NUMBER</b> </p> <p>The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. </p> </li> <li> <p> <b>PIN</b> </p> <p>A four-digit personal identification number (PIN) with which you can access your bank account. </p> </li> <li> <p> <b>INTERNATIONAL_BANK_ACCOUNT_NUMBER</b> </p> <p>An International Bank Account Number has specific formats in each country. For more information, see <a href="https://www.iban.com/structure"> www.iban.com/structure</a>.</p> </li> <li> <p> <b>SWIFT_CODE</b> </p> <p>A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.</p> <p>SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.</p> </li> </ul> </li> <li> <p> <b>IT</b> </p> <ul> <li> <p> <b>IP_ADDRESS</b> </p> <p>An IPv4 address, such as <i>198.51.100.0</i>. </p> </li> <li> <p> <b>MAC_ADDRESS</b> </p> <p>A <i>media access control</i> (MAC) address is a unique identifier assigned to a network interface controller (NIC). </p> </li> <li> <p> <b>URL</b> </p> <p>A web address, such as <i>www.example.com</i>. </p> </li> <li> <p> <b>AWS_ACCESS_KEY</b> </p> <p>A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> <li> <p> <b>AWS_SECRET_KEY</b> </p> <p>A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically. </p> </li> </ul> </li> <li> <p> <b>USA specific</b> </p> <ul> <li> <p> <b>US_BANK_ACCOUNT_NUMBER</b> </p> <p>A US bank account number, which is typically 10 to 12 digits long. </p> </li> <li> <p> <b>US_BANK_ROUTING_NUMBER</b> </p> <p>A US bank account routing number. These are typically nine digits long, </p> </li> <li> <p> <b>US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER</b> </p> <p>A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. </p> </li> <li> <p> <b>US_PASSPORT_NUMBER</b> </p> <p>A US passport number. Passport numbers range from six to nine alphanumeric characters. </p> </li> <li> <p> <b>US_SOCIAL_SECURITY_NUMBER</b> </p> <p>A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. </p> </li> </ul> </li> <li> <p> <b>Canada specific</b> </p> <ul> <li> <p> <b>CA_HEALTH_NUMBER</b> </p> <p>A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. </p> </li> <li> <p> <b>CA_SOCIAL_INSURANCE_NUMBER</b> </p> <p>A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.</p> <p>The SIN is formatted as three groups of three digits, such as <i> 123-456-789</i>. A SIN can be validated through a simple check-digit process called the Luhn algorithm. For more information, see <a href="https://www.wikipedia.org/wiki/Luhn_algorithm">Luhn algorithm</a> on the Wikipedia website.</p> </li> </ul> </li> <li> <p> <b>UK Specific</b> </p> <ul> <li> <p> <b>UK_NATIONAL_HEALTH_SERVICE_NUMBER</b> </p> <p>A UK National Health Service Number is a 10-17 digit number, such as <i>485 555 3456</i>. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.</p> </li> <li> <p> <b>UK_NATIONAL_INSURANCE_NUMBER</b> </p> <p>A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.</p> <p>The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.</p> </li> <li> <p> <b>UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER</b> </p> <p>A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. </p> </li> </ul> </li> <li> <p> <b>Custom</b> </p> <ul> <li> <p> <b>Regex filter</b> - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..</p> </li> </ul> </li> </ul>
1414
1577
  * @public
1415
1578
  */
1416
1579
  type: GuardrailPiiEntityType | undefined;
@@ -2650,7 +2813,7 @@ export interface UpdateAIPromptResponse {
2650
2813
  */
2651
2814
  export interface AmazonConnectGuideAssociationData {
2652
2815
  /**
2653
- * <p> The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.</p>
2816
+ * <p> The Amazon Resource Name (ARN) of an Connect Customer flow. Step-by-step guides are a type of flow.</p>
2654
2817
  * @public
2655
2818
  */
2656
2819
  flowId?: string | undefined;
@@ -4458,7 +4621,7 @@ export interface CreateSessionRequest {
4458
4621
  */
4459
4622
  aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
4460
4623
  /**
4461
- * <p>The Amazon Resource Name (ARN) of the email contact in Amazon Connect. Used to retrieve email content and establish session context for AI-powered email assistance.</p>
4624
+ * <p>The Amazon Resource Name (ARN) of the email contact in Connect Customer. Used to retrieve email content and establish session context for AI-powered email assistance.</p>
4462
4625
  * @public
4463
4626
  */
4464
4627
  contactArn?: string | undefined;
@@ -4722,7 +4885,7 @@ export interface ToolUseResultData {
4722
4885
  * <p>The message data.</p>
4723
4886
  * @public
4724
4887
  */
4725
- export type MessageData = MessageData.TextMember | MessageData.ToolUseResultMember | MessageData.$UnknownMember;
4888
+ export type MessageData = MessageData.DataMember | MessageData.TextMember | MessageData.ToolUseResultMember | MessageData.$UnknownMember;
4726
4889
  /**
4727
4890
  * @public
4728
4891
  */
@@ -4734,6 +4897,7 @@ export declare namespace MessageData {
4734
4897
  interface TextMember {
4735
4898
  text: TextMessage;
4736
4899
  toolUseResult?: never;
4900
+ data?: never;
4737
4901
  $unknown?: never;
4738
4902
  }
4739
4903
  /**
@@ -4743,6 +4907,17 @@ export declare namespace MessageData {
4743
4907
  interface ToolUseResultMember {
4744
4908
  text?: never;
4745
4909
  toolUseResult: ToolUseResultData;
4910
+ data?: never;
4911
+ $unknown?: never;
4912
+ }
4913
+ /**
4914
+ * <p>The message data as a structured JSON document. This is the payload for a message of type <code>DATA</code>, and must be a JSON object at the root level.</p>
4915
+ * @public
4916
+ */
4917
+ interface DataMember {
4918
+ text?: never;
4919
+ toolUseResult?: never;
4920
+ data: __DocumentType;
4746
4921
  $unknown?: never;
4747
4922
  }
4748
4923
  /**
@@ -4751,6 +4926,7 @@ export declare namespace MessageData {
4751
4926
  interface $UnknownMember {
4752
4927
  text?: never;
4753
4928
  toolUseResult?: never;
4929
+ data?: never;
4754
4930
  $unknown: [string, any];
4755
4931
  }
4756
4932
  /**
@@ -4760,6 +4936,7 @@ export declare namespace MessageData {
4760
4936
  interface Visitor<T> {
4761
4937
  text: (value: TextMessage) => T;
4762
4938
  toolUseResult: (value: ToolUseResultData) => T;
4939
+ data: (value: __DocumentType) => T;
4763
4940
  _: (name: string, value: any) => T;
4764
4941
  }
4765
4942
  }
@@ -5174,7 +5351,7 @@ export interface SendMessageRequest {
5174
5351
  */
5175
5352
  metadata?: Record<string, string> | undefined;
5176
5353
  /**
5177
- * Request identifier from the origin system, used for end-to-end tracing across spans.
5354
+ * <p>Request identifier from the origin system, used for end-to-end tracing across spans.</p>
5178
5355
  * @public
5179
5356
  */
5180
5357
  originRequestId?: string | undefined;
@@ -5452,12 +5629,12 @@ export interface ChunkingConfiguration {
5452
5629
  semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
5453
5630
  }
5454
5631
  /**
5455
- * <p>The configuration information of the Amazon Connect data source.</p>
5632
+ * <p>The configuration information of the Connect Customer data source.</p>
5456
5633
  * @public
5457
5634
  */
5458
5635
  export interface ConnectConfiguration {
5459
5636
  /**
5460
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5637
+ * <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the instance.</p>
5461
5638
  * @public
5462
5639
  */
5463
5640
  instanceId?: string | undefined;
@@ -5472,7 +5649,7 @@ export type Configuration = Configuration.ConnectConfigurationMember | Configura
5472
5649
  */
5473
5650
  export declare namespace Configuration {
5474
5651
  /**
5475
- * <p>The configuration information of the Amazon Connect data source.</p>
5652
+ * <p>The configuration information of the Connect Customer data source.</p>
5476
5653
  * @public
5477
5654
  */
5478
5655
  interface ConnectConfigurationMember {
@@ -7222,7 +7399,7 @@ export interface GroupingConfiguration {
7222
7399
  */
7223
7400
  criteria?: string | undefined;
7224
7401
  /**
7225
- * <p>The list of values that define different groups of Amazon Q in Connect users.</p> <ul> <li> <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p> </li> </ul>
7402
+ * <p>The list of values that define different groups of Amazon Q in Connect users.</p> <ul> <li> <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Connect Customer routing profiles</a> as values of this parameter.</p> </li> </ul>
7226
7403
  * @public
7227
7404
  */
7228
7405
  values?: string[] | undefined;
@@ -7627,260 +7804,3 @@ export interface CreateMessageTemplateVersionRequest {
7627
7804
  */
7628
7805
  messageTemplateContentSha256?: string | undefined;
7629
7806
  }
7630
- /**
7631
- * <p>The extended data of a message template.</p>
7632
- * @public
7633
- */
7634
- export interface ExtendedMessageTemplateData {
7635
- /**
7636
- * <p>The Amazon Resource Name (ARN) of the message template.</p>
7637
- * @public
7638
- */
7639
- messageTemplateArn: string | undefined;
7640
- /**
7641
- * <p>The identifier of the message template.</p>
7642
- * @public
7643
- */
7644
- messageTemplateId: string | undefined;
7645
- /**
7646
- * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
7647
- * @public
7648
- */
7649
- knowledgeBaseArn: string | undefined;
7650
- /**
7651
- * <p>The identifier of the knowledge base.</p>
7652
- * @public
7653
- */
7654
- knowledgeBaseId: string | undefined;
7655
- /**
7656
- * <p>The name of the message template.</p>
7657
- * @public
7658
- */
7659
- name: string | undefined;
7660
- /**
7661
- * <p>The channel of the message template.</p>
7662
- * @public
7663
- */
7664
- channel?: string | undefined;
7665
- /**
7666
- * <p>The channel subtype this message template applies to.</p>
7667
- * @public
7668
- */
7669
- channelSubtype: ChannelSubtype | undefined;
7670
- /**
7671
- * <p>The timestamp when the message template was created.</p>
7672
- * @public
7673
- */
7674
- createdTime: Date | undefined;
7675
- /**
7676
- * <p>The timestamp when the message template data was last modified.</p>
7677
- * @public
7678
- */
7679
- lastModifiedTime: Date | undefined;
7680
- /**
7681
- * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
7682
- * @public
7683
- */
7684
- lastModifiedBy: string | undefined;
7685
- /**
7686
- * <p>The content of the message template.</p>
7687
- * @public
7688
- */
7689
- content?: MessageTemplateContentProvider | undefined;
7690
- /**
7691
- * <p>The description of the message template.</p>
7692
- * @public
7693
- */
7694
- description?: string | undefined;
7695
- /**
7696
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
7697
- * @public
7698
- */
7699
- language?: string | undefined;
7700
- /**
7701
- * <p>The source configuration summary of the message template.</p>
7702
- * @public
7703
- */
7704
- sourceConfigurationSummary?: MessageTemplateSourceConfigurationSummary | undefined;
7705
- /**
7706
- * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
7707
- * @public
7708
- */
7709
- groupingConfiguration?: GroupingConfiguration | undefined;
7710
- /**
7711
- * <p>An object that specifies the default 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. The corresponding value defines the default value for that variable.</p>
7712
- * @public
7713
- */
7714
- defaultAttributes?: MessageTemplateAttributes | undefined;
7715
- /**
7716
- * <p>The types of attributes contain the message template.</p>
7717
- * @public
7718
- */
7719
- attributeTypes?: MessageTemplateAttributeType[] | undefined;
7720
- /**
7721
- * <p>The message template attachments.</p>
7722
- * @public
7723
- */
7724
- attachments?: MessageTemplateAttachment[] | undefined;
7725
- /**
7726
- * <p>Whether the version of the message template is activated.</p>
7727
- * @public
7728
- */
7729
- isActive?: boolean | undefined;
7730
- /**
7731
- * <p>The version number of the message template version.</p>
7732
- * @public
7733
- */
7734
- versionNumber?: number | undefined;
7735
- /**
7736
- * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
7737
- * @public
7738
- */
7739
- messageTemplateContentSha256: string | undefined;
7740
- /**
7741
- * <p>The tags used to organize, track, or control access for this resource.</p>
7742
- * @public
7743
- */
7744
- tags?: Record<string, string> | undefined;
7745
- }
7746
- /**
7747
- * @public
7748
- */
7749
- export interface CreateMessageTemplateVersionResponse {
7750
- /**
7751
- * <p>The message template.</p>
7752
- * @public
7753
- */
7754
- messageTemplate?: ExtendedMessageTemplateData | undefined;
7755
- }
7756
- /**
7757
- * <p>The container of quick response data.</p>
7758
- * @public
7759
- */
7760
- export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
7761
- /**
7762
- * @public
7763
- */
7764
- export declare namespace QuickResponseDataProvider {
7765
- /**
7766
- * <p>The content of the quick response.</p>
7767
- * @public
7768
- */
7769
- interface ContentMember {
7770
- content: string;
7771
- $unknown?: never;
7772
- }
7773
- /**
7774
- * @public
7775
- */
7776
- interface $UnknownMember {
7777
- content?: never;
7778
- $unknown: [string, any];
7779
- }
7780
- /**
7781
- * @deprecated unused in schema-serde mode.
7782
- *
7783
- */
7784
- interface Visitor<T> {
7785
- content: (value: string) => T;
7786
- _: (name: string, value: any) => T;
7787
- }
7788
- }
7789
- /**
7790
- * @public
7791
- */
7792
- export interface CreateQuickResponseRequest {
7793
- /**
7794
- * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
7795
- * @public
7796
- */
7797
- knowledgeBaseId: string | undefined;
7798
- /**
7799
- * <p>The name of the quick response.</p>
7800
- * @public
7801
- */
7802
- name: string | undefined;
7803
- /**
7804
- * <p>The content of the quick response.</p>
7805
- * @public
7806
- */
7807
- content: QuickResponseDataProvider | undefined;
7808
- /**
7809
- * <p>The media type of the quick response content.</p> <ul> <li> <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p> </li> <li> <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p> </li> </ul>
7810
- * @public
7811
- */
7812
- contentType?: string | undefined;
7813
- /**
7814
- * <p>The configuration information of the user groups that the quick response is accessible to.</p>
7815
- * @public
7816
- */
7817
- groupingConfiguration?: GroupingConfiguration | undefined;
7818
- /**
7819
- * <p>The description of the quick response.</p>
7820
- * @public
7821
- */
7822
- description?: string | undefined;
7823
- /**
7824
- * <p>The shortcut key of the quick response. The value should be unique across the knowledge base. </p>
7825
- * @public
7826
- */
7827
- shortcutKey?: string | undefined;
7828
- /**
7829
- * <p>Whether the quick response is active.</p>
7830
- * @public
7831
- */
7832
- isActive?: boolean | undefined;
7833
- /**
7834
- * <p>The Amazon Connect channels this quick response applies to.</p>
7835
- * @public
7836
- */
7837
- channels?: string[] | undefined;
7838
- /**
7839
- * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
7840
- * @public
7841
- */
7842
- language?: string | undefined;
7843
- /**
7844
- * <p>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 <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
7845
- * @public
7846
- */
7847
- clientToken?: string | undefined;
7848
- /**
7849
- * <p>The tags used to organize, track, or control access for this resource.</p>
7850
- * @public
7851
- */
7852
- tags?: Record<string, string> | undefined;
7853
- }
7854
- /**
7855
- * <p>The container quick response content.</p>
7856
- * @public
7857
- */
7858
- export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
7859
- /**
7860
- * @public
7861
- */
7862
- export declare namespace QuickResponseContentProvider {
7863
- /**
7864
- * <p>The content of the quick response.</p>
7865
- * @public
7866
- */
7867
- interface ContentMember {
7868
- content: string;
7869
- $unknown?: never;
7870
- }
7871
- /**
7872
- * @public
7873
- */
7874
- interface $UnknownMember {
7875
- content?: never;
7876
- $unknown: [string, any];
7877
- }
7878
- /**
7879
- * @deprecated unused in schema-serde mode.
7880
- *
7881
- */
7882
- interface Visitor<T> {
7883
- content: (value: string) => T;
7884
- _: (name: string, value: any) => T;
7885
- }
7886
- }