diff --git a/.changes/2.1601.0.json b/.changes/2.1601.0.json new file mode 100644 index 0000000000..81d02f105d --- /dev/null +++ b/.changes/2.1601.0.json @@ -0,0 +1,17 @@ +[ + { + "type": "bugfix", + "category": "Endpoints", + "description": "Add endpoint override for us-isof-* region" + }, + { + "type": "feature", + "category": "EC2", + "description": "Documentation updates for Elastic Compute Cloud (EC2)." + }, + { + "type": "feature", + "category": "QBusiness", + "description": "This release adds support for IAM Identity Center (IDC) as the identity gateway for Q Business. It also allows users to provide an explicit intent for Q Business to identify how the Chat request should be handled." + } +] \ No newline at end of file diff --git a/.changes/next-release/bugfix-Endpoints-8c993a32.json b/.changes/next-release/bugfix-Endpoints-8c993a32.json deleted file mode 100644 index 4a2f8661c3..0000000000 --- a/.changes/next-release/bugfix-Endpoints-8c993a32.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "bugfix", - "category": "Endpoints", - "description": "Add endpoint override for us-isof-* region" -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3abd31c9d4..a5a2160a87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,12 @@ # Changelog for AWS SDK for JavaScript - + +## 2.1601.0 +* bugfix: Endpoints: Add endpoint override for us-isof-* region +* feature: EC2: Documentation updates for Elastic Compute Cloud (EC2). +* feature: QBusiness: This release adds support for IAM Identity Center (IDC) as the identity gateway for Q Business. It also allows users to provide an explicit intent for Q Business to identify how the Chat request should be handled. + ## 2.1600.0 * feature: BedrockAgent: For Create Agent API, the agentResourceRoleArn parameter is no longer required. * feature: EMRServerless: This release adds support for shuffle optimized disks that allow larger disk sizes and higher IOPS to efficiently run shuffle heavy workloads. diff --git a/README.md b/README.md index 6308a40f0d..f829f08608 100644 --- a/README.md +++ b/README.md @@ -64,7 +64,7 @@ require('aws-sdk/lib/maintenance_mode_message').suppress = true; To use the SDK in the browser, simply add the following script tag to your HTML pages: - + You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of diff --git a/apis/ec2-2016-11-15.normal.json b/apis/ec2-2016-11-15.normal.json index de6c6f39ce..2e09196821 100644 --- a/apis/ec2-2016-11-15.normal.json +++ b/apis/ec2-2016-11-15.normal.json @@ -698,7 +698,7 @@ "output": { "shape": "CancelSpotFleetRequestsResponse" }, - "documentation": "
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating
state. Otherwise, the Spot Fleet request enters the cancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.
Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new instances.
You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the cancelled_terminating
state. Otherwise, the Spot Fleet request enters the cancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.
Restrictions
You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted.
Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating
state. Otherwise, the EC2 Fleet enters the deleted_running
state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant
fleets, EC2 Fleet must terminate the instances when the fleet is deleted. A deleted instant
fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant
fleets in a single request. If you exceed this number, no instant
fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain
or request
that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant
fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
" + "documentation": "Deletes the specified EC2 Fleets.
After you delete an EC2 Fleet, it launches no new instances.
You must also specify whether a deleted EC2 Fleet should terminate its instances. If you choose to terminate the instances, the EC2 Fleet enters the deleted_terminating
state. Otherwise, the EC2 Fleet enters the deleted_running
state, and the instances continue to run until they are interrupted or you terminate them manually.
For instant
fleets, EC2 Fleet must terminate the instances when the fleet is deleted. Up to 1000 instances can be terminated in a single request to delete instant
fleets. A deleted instant
fleet with running instances is not supported.
Restrictions
You can delete up to 25 fleets of type instant
in a single request.
You can delete up to 100 fleets of type maintain
or request
in a single request.
You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above.
If you exceed the specified number of fleets to delete, no fleets are deleted.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
" }, "DeleteFlowLogs": { "name": "DeleteFlowLogs", @@ -3737,7 +3737,7 @@ "output": { "shape": "DescribeInstanceTypeOfferingsResult" }, - "documentation": "Returns a list of all instance types offered. The results can be filtered by location (Region or Availability Zone). If no location is specified, the instance types offered in the current Region are returned.
" + "documentation": "Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
" }, "DescribeInstanceTypes": { "name": "DescribeInstanceTypes", @@ -3751,7 +3751,7 @@ "output": { "shape": "DescribeInstanceTypesResult" }, - "documentation": "Describes the details of the instance types that are offered in a location. The results can be filtered by the attributes of the instance types.
" + "documentation": "Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
" }, "DescribeInstances": { "name": "DescribeInstances", @@ -5967,7 +5967,7 @@ "output": { "shape": "GetConsoleScreenshotResult" }, - "documentation": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
" + "documentation": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
For more information, see Instance console output in the Amazon EC2 User Guide.
" }, "GetDefaultCreditSpecification": { "name": "GetDefaultCreditSpecification", @@ -6935,7 +6935,7 @@ "output": { "shape": "ModifyInstanceMetadataDefaultsResult" }, - "documentation": "Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference
. At instance launch, the value will come from the AMI, or from the launch parameter if specified. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
Modifies the default instance metadata service (IMDS) settings at the account level in the specified Amazon Web Services Region.
To remove a parameter's account-level default setting, specify no-preference
. If an account-level setting is cleared with no-preference
, then the instance launch considers the other instance metadata settings. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.
The IDs of the Spot Fleet requests.
", + "documentation": "The IDs of the Spot Fleet requests.
Constraint: You can specify up to 100 IDs in a single request.
", "locationName": "spotFleetRequestId" }, "TerminateInstances": { @@ -15187,12 +15187,12 @@ }, "ErrorCode": { "shape": "String", - "documentation": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", + "documentation": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", "locationName": "errorCode" }, "ErrorMessage": { "shape": "String", - "documentation": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", + "documentation": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", "locationName": "errorMessage" } }, @@ -19437,7 +19437,7 @@ }, "FleetIds": { "shape": "FleetIdSet", - "documentation": "The IDs of the EC2 Fleets.
", + "documentation": "The IDs of the EC2 Fleets.
Constraints: In a single request, you can specify up to 25 instant
fleet IDs and up to 100 maintain
or request
fleet IDs.
The location type.
" + "documentation": "The location type.
availability-zone
- The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region.
availability-zone-id
- The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region.
outpost
- The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region.
region
- The current Region. If you specify a location filter, it must match the current Region.
One or more filters. Filter names and values are case-sensitive.
location
- This depends on the location type. For example, if the location type is region
(default), the location is the Region code (for example, us-east-2
.)
instance-type
- The instance type. For example, c5.2xlarge
.
One or more filters. Filter names and values are case-sensitive.
instance-type
- The instance type. For a list of possible values, see Instance.
location
- The location. For a list of possible identifiers, see Regions and Zones.
The instance types offered.
", + "documentation": "The instance types offered in the location.
", "locationName": "instanceTypeOfferingSet" }, "NextToken": { @@ -23886,7 +23886,7 @@ }, "InstanceTypes": { "shape": "RequestInstanceTypeList", - "documentation": "The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
", + "documentation": "The instance types.
", "locationName": "InstanceType" }, "Filters": { @@ -23909,7 +23909,7 @@ "members": { "InstanceTypes": { "shape": "InstanceTypeInfoList", - "documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", + "documentation": "The instance type.
", "locationName": "instanceTypeSet" }, "NextToken": { @@ -45595,7 +45595,7 @@ }, "HttpPutResponseHopLimit": { "shape": "BoxedInteger", - "documentation": "The maximum number of hops that the metadata token can travel.
Minimum: 1
Maximum: 64
The maximum number of hops that the metadata token can travel. To indicate no preference, specify -1
.
Possible values: Integers from 1
to 64
, and -1
to indicate no preference
One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
", + "documentation": "The network interfaces for the instance.
", "locationName": "NetworkInterface" }, "ImageId": { @@ -52798,12 +52798,12 @@ }, "SecurityGroupIds": { "shape": "SecurityGroupIdStringList", - "documentation": "One or more security group IDs. You can create a security group using CreateSecurityGroup.
", + "documentation": "The IDs of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroupId" }, "SecurityGroups": { "shape": "SecurityGroupStringList", - "documentation": "One or more security group names. For a nondefault VPC, you must use security group IDs instead.
", + "documentation": "The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroup" }, "InstanceMarketOptions": { @@ -55000,17 +55000,17 @@ }, "SecurityGroupIds": { "shape": "SecurityGroupIdStringList", - "documentation": "The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
", + "documentation": "The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "SecurityGroupId" }, "SecurityGroups": { "shape": "SecurityGroupStringList", - "documentation": "[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
", + "documentation": "[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
Default: Amazon EC2 uses the default security group.
", "locationName": "SecurityGroup" }, "SubnetId": { "shape": "SubnetId", - "documentation": "The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
" + "documentation": "The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
" }, "UserData": { "shape": "RunInstancesUserData", @@ -55054,7 +55054,7 @@ }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceSpecificationList", - "documentation": "The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.
", + "documentation": "The network interfaces to associate with the instance.
", "locationName": "networkInterface" }, "PrivateIpAddress": { @@ -55064,11 +55064,11 @@ }, "ElasticGpuSpecification": { "shape": "ElasticGpuSpecifications", - "documentation": "Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference (EI) is no longer available to new customers. For more information, see Amazon Elastic Inference FAQs.
The maximum number of routes to return.
" + "documentation": "The maximum number of routes to return. If a value is not provided, the default is 1000.
" }, "DryRun": { "shape": "Boolean", @@ -57049,7 +57049,7 @@ "members": { "SecurityGroups": { "shape": "GroupIdentifierList", - "documentation": "The security groups.
", + "documentation": "The security groups.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
", "locationName": "groupSet" }, "AddressingType": { @@ -57099,7 +57099,7 @@ }, "NetworkInterfaces": { "shape": "InstanceNetworkInterfaceSpecificationList", - "documentation": "One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification
currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The network interfaces.
SpotFleetLaunchSpecification
does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".
", + "documentation": "The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
", "locationName": "subnetId" }, "UserData": { diff --git a/apis/qbusiness-2023-11-27.min.json b/apis/qbusiness-2023-11-27.min.json index 05ab49d58d..2cbcde8325 100644 --- a/apis/qbusiness-2023-11-27.min.json +++ b/apis/qbusiness-2023-11-27.min.json @@ -194,8 +194,7 @@ "input": { "type": "structure", "required": [ - "applicationId", - "userId" + "applicationId" ], "members": { "actionExecution": { @@ -224,13 +223,29 @@ "attributeFilter": { "shape": "S1x" }, + "chatMode": {}, + "chatModeConfiguration": { + "type": "structure", + "members": { + "pluginConfiguration": { + "type": "structure", + "required": [ + "pluginId" + ], + "members": { + "pluginId": {} + } + } + }, + "union": true + }, "clientToken": { "idempotencyToken": true }, "conversationId": {}, "parentMessageId": {}, "userGroups": { - "shape": "S22", + "shape": "S25", "location": "querystring", "locationName": "userGroups" }, @@ -245,14 +260,14 @@ "type": "structure", "members": { "actionReview": { - "shape": "S25" + "shape": "S28" }, "conversationId": {}, "failedAttachments": { - "shape": "S2e" + "shape": "S2h" }, "sourceAttributions": { - "shape": "S2h" + "shape": "S2k" }, "systemMessage": {}, "systemMessageId": {}, @@ -273,7 +288,7 @@ ], "members": { "attachmentsConfiguration": { - "shape": "S2m" + "shape": "S2p" }, "clientToken": { "idempotencyToken": true @@ -281,11 +296,12 @@ "description": {}, "displayName": {}, "encryptionConfiguration": { - "shape": "S2q" + "shape": "S2t" }, + "identityCenterInstanceArn": {}, "roleArn": {}, "tags": { - "shape": "S2s" + "shape": "S2w" } } }, @@ -320,7 +336,7 @@ "idempotencyToken": true }, "configuration": { - "shape": "S2z" + "shape": "S33" }, "description": {}, "displayName": {}, @@ -334,10 +350,10 @@ "roleArn": {}, "syncSchedule": {}, "tags": { - "shape": "S2s" + "shape": "S2w" }, "vpcConfiguration": { - "shape": "S32" + "shape": "S36" } } }, @@ -367,7 +383,7 @@ "locationName": "applicationId" }, "capacityConfiguration": { - "shape": "S3a" + "shape": "S3e" }, "clientToken": { "idempotencyToken": true @@ -375,7 +391,7 @@ "description": {}, "displayName": {}, "tags": { - "shape": "S2s" + "shape": "S2w" } } }, @@ -407,7 +423,7 @@ "locationName": "applicationId" }, "authConfiguration": { - "shape": "S3g" + "shape": "S3k" }, "clientToken": { "idempotencyToken": true @@ -415,7 +431,7 @@ "displayName": {}, "serverUrl": {}, "tags": { - "shape": "S2s" + "shape": "S2w" }, "type": {} } @@ -451,12 +467,12 @@ "idempotencyToken": true }, "configuration": { - "shape": "S3p" + "shape": "S3t" }, "displayName": {}, "roleArn": {}, "tags": { - "shape": "S2s" + "shape": "S2w" }, "type": {} } @@ -491,7 +507,7 @@ "userAliases": { "type": "list", "member": { - "shape": "S4b" + "shape": "S4f" } }, "userId": {} @@ -521,10 +537,11 @@ "clientToken": { "idempotencyToken": true }, + "roleArn": {}, "samplePromptsControlMode": {}, "subtitle": {}, "tags": { - "shape": "S2s" + "shape": "S2w" }, "title": {}, "welcomeMessage": {} @@ -596,8 +613,7 @@ "type": "structure", "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "members": { "applicationId": { @@ -872,11 +888,12 @@ "description": {}, "displayName": {}, "encryptionConfiguration": { - "shape": "S2q" + "shape": "S2t" }, "error": { "shape": "Sc" }, + "identityCenterApplicationArn": {}, "roleArn": {}, "status": {}, "updatedAt": { @@ -919,15 +936,24 @@ "type": "structure", "members": { "blockedPhrases": { - "shape": "S5e" + "shape": "S5j" }, "systemMessageOverride": {} } }, + "creatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": {} + } + }, "nextToken": {}, "responseScope": {}, "topicConfigurations": { - "shape": "S5i" + "shape": "S5p" } } } @@ -965,7 +991,7 @@ "members": { "applicationId": {}, "configuration": { - "shape": "S2z" + "shape": "S33" }, "createdAt": { "type": "timestamp" @@ -989,7 +1015,7 @@ "type": "timestamp" }, "vpcConfiguration": { - "shape": "S32" + "shape": "S36" } } } @@ -1030,12 +1056,12 @@ "type": "structure", "members": { "status": { - "shape": "S63" + "shape": "S6a" }, "statusHistory": { "type": "list", "member": { - "shape": "S63" + "shape": "S6a" } } } @@ -1069,7 +1095,7 @@ "members": { "applicationId": {}, "capacityConfiguration": { - "shape": "S3a" + "shape": "S3e" }, "createdAt": { "type": "timestamp" @@ -1077,7 +1103,7 @@ "description": {}, "displayName": {}, "documentAttributeConfigurations": { - "shape": "S68" + "shape": "S6f" }, "error": { "shape": "Sc" @@ -1135,7 +1161,7 @@ "members": { "applicationId": {}, "authConfiguration": { - "shape": "S3g" + "shape": "S3k" }, "createdAt": { "type": "timestamp" @@ -1180,7 +1206,7 @@ "members": { "applicationId": {}, "configuration": { - "shape": "S3p" + "shape": "S3t" }, "createdAt": { "type": "timestamp" @@ -1224,7 +1250,7 @@ "type": "structure", "members": { "userAliases": { - "shape": "S6p" + "shape": "S6w" } } } @@ -1257,7 +1283,7 @@ "members": { "applicationId": {}, "authenticationConfiguration": { - "shape": "S6s" + "shape": "S6z" }, "createdAt": { "type": "timestamp" @@ -1266,6 +1292,7 @@ "error": { "shape": "Sc" }, + "roleArn": {}, "samplePromptsControlMode": {}, "status": {}, "subtitle": {}, @@ -1332,8 +1359,7 @@ "input": { "type": "structure", "required": [ - "applicationId", - "userId" + "applicationId" ], "members": { "applicationId": { @@ -1703,8 +1729,7 @@ "type": "structure", "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "members": { "applicationId": { @@ -1742,15 +1767,15 @@ "shape": "S1n" }, "actionReview": { - "shape": "S25" + "shape": "S28" }, "attachments": { - "shape": "S2e" + "shape": "S2h" }, "body": {}, "messageId": {}, "sourceAttribution": { - "shape": "S2h" + "shape": "S2k" }, "time": { "type": "timestamp" @@ -1885,7 +1910,7 @@ "type": "structure", "members": { "tags": { - "shape": "S2s" + "shape": "S2w" } } } @@ -1951,8 +1976,7 @@ "required": [ "applicationId", "conversationId", - "messageId", - "userId" + "messageId" ], "members": { "applicationId": { @@ -2141,7 +2165,7 @@ "locationName": "resourceARN" }, "tags": { - "shape": "S2s" + "shape": "S2w" } } }, @@ -2199,7 +2223,7 @@ "locationName": "applicationId" }, "attachmentsConfiguration": { - "shape": "S2m" + "shape": "S2p" }, "description": {}, "displayName": {}, @@ -2232,10 +2256,10 @@ "type": "structure", "members": { "blockedPhrasesToCreateOrUpdate": { - "shape": "S5e" + "shape": "S5j" }, "blockedPhrasesToDelete": { - "shape": "S5e" + "shape": "S5j" }, "systemMessageOverride": {} } @@ -2243,12 +2267,21 @@ "clientToken": { "idempotencyToken": true }, + "creatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": {} + } + }, "responseScope": {}, "topicConfigurationsToCreateOrUpdate": { - "shape": "S5i" + "shape": "S5p" }, "topicConfigurationsToDelete": { - "shape": "S5i" + "shape": "S5p" } } }, @@ -2277,7 +2310,7 @@ "locationName": "applicationId" }, "configuration": { - "shape": "S2z" + "shape": "S33" }, "dataSourceId": { "location": "uri", @@ -2295,7 +2328,7 @@ "roleArn": {}, "syncSchedule": {}, "vpcConfiguration": { - "shape": "S32" + "shape": "S36" } } }, @@ -2323,12 +2356,12 @@ "locationName": "applicationId" }, "capacityConfiguration": { - "shape": "S3a" + "shape": "S3e" }, "description": {}, "displayName": {}, "documentAttributeConfigurations": { - "shape": "S68" + "shape": "S6f" }, "indexId": { "location": "uri", @@ -2360,7 +2393,7 @@ "locationName": "applicationId" }, "authConfiguration": { - "shape": "S3g" + "shape": "S3k" }, "displayName": {}, "pluginId": { @@ -2395,7 +2428,7 @@ "locationName": "applicationId" }, "configuration": { - "shape": "S3p" + "shape": "S3t" }, "displayName": {}, "retrieverId": { @@ -2429,10 +2462,10 @@ "locationName": "applicationId" }, "userAliasesToDelete": { - "shape": "S6p" + "shape": "S6w" }, "userAliasesToUpdate": { - "shape": "S6p" + "shape": "S6w" }, "userId": { "location": "uri", @@ -2444,13 +2477,13 @@ "type": "structure", "members": { "userAliasesAdded": { - "shape": "S6p" + "shape": "S6w" }, "userAliasesDeleted": { - "shape": "S6p" + "shape": "S6w" }, "userAliasesUpdated": { - "shape": "S6p" + "shape": "S6w" } } }, @@ -2474,7 +2507,7 @@ "locationName": "applicationId" }, "authenticationConfiguration": { - "shape": "S6s" + "shape": "S6z" }, "samplePromptsControlMode": {}, "subtitle": {}, @@ -2678,11 +2711,11 @@ "shape": "S1x" } }, - "S22": { + "S25": { "type": "list", "member": {} }, - "S25": { + "S28": { "type": "structure", "members": { "payload": { @@ -2724,7 +2757,7 @@ "pluginType": {} } }, - "S2e": { + "S2h": { "type": "list", "member": { "type": "structure", @@ -2737,7 +2770,7 @@ } } }, - "S2h": { + "S2k": { "type": "list", "member": { "type": "structure", @@ -2768,7 +2801,7 @@ } } }, - "S2m": { + "S2p": { "type": "structure", "required": [ "attachmentsControlMode" @@ -2777,7 +2810,7 @@ "attachmentsControlMode": {} } }, - "S2q": { + "S2t": { "type": "structure", "members": { "kmsKeyId": { @@ -2786,7 +2819,7 @@ } } }, - "S2s": { + "S2w": { "type": "list", "member": { "type": "structure", @@ -2800,12 +2833,12 @@ } } }, - "S2z": { + "S33": { "type": "structure", "members": {}, "document": true }, - "S32": { + "S36": { "type": "structure", "required": [ "securityGroupIds", @@ -2822,7 +2855,7 @@ } } }, - "S3a": { + "S3e": { "type": "structure", "members": { "units": { @@ -2830,7 +2863,7 @@ } } }, - "S3g": { + "S3k": { "type": "structure", "members": { "basicAuthConfiguration": { @@ -2858,7 +2891,7 @@ }, "union": true }, - "S3p": { + "S3t": { "type": "structure", "members": { "kendraIndexConfiguration": { @@ -2937,7 +2970,7 @@ }, "union": true }, - "S4b": { + "S4f": { "type": "structure", "required": [ "userId" @@ -2948,11 +2981,11 @@ "userId": {} } }, - "S5e": { + "S5j": { "type": "list", "member": {} }, - "S5i": { + "S5p": { "type": "list", "member": { "type": "structure", @@ -2976,10 +3009,10 @@ ], "members": { "excludedUsersAndGroups": { - "shape": "S5q" + "shape": "S5x" }, "includedUsersAndGroups": { - "shape": "S5q" + "shape": "S5x" }, "ruleConfiguration": { "type": "structure", @@ -3015,11 +3048,11 @@ } } }, - "S5q": { + "S5x": { "type": "structure", "members": { "userGroups": { - "shape": "S22" + "shape": "S25" }, "userIds": { "type": "list", @@ -3027,7 +3060,7 @@ } } }, - "S63": { + "S6a": { "type": "structure", "members": { "errorDetail": { @@ -3039,7 +3072,7 @@ "status": {} } }, - "S68": { + "S6f": { "type": "list", "member": { "type": "structure", @@ -3050,13 +3083,13 @@ } } }, - "S6p": { + "S6w": { "type": "list", "member": { - "shape": "S4b" + "shape": "S4f" } }, - "S6s": { + "S6z": { "type": "structure", "members": { "samlConfiguration": { diff --git a/apis/qbusiness-2023-11-27.normal.json b/apis/qbusiness-2023-11-27.normal.json index 29572da4c8..64d9215f69 100644 --- a/apis/qbusiness-2023-11-27.normal.json +++ b/apis/qbusiness-2023-11-27.normal.json @@ -45,7 +45,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Asynchronously deletes one or more documents added using the BatchPutDocument
API from an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
" + "documentation": "Asynchronously deletes one or more documents added using the BatchPutDocument
API from an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
" }, "BatchPutDocument": { "name": "BatchPutDocument", @@ -83,7 +83,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Adds one or more documents to an Amazon Q index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q index.
add custom attributes to documents in an Amazon Q index.
attach an access control list to the documents added to an Amazon Q index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
" + "documentation": "Adds one or more documents to an Amazon Q Business index.
You use this API to:
ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.
add custom attributes to documents in an Amazon Q Business index.
attach an access control list to the documents added to an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
" }, "ChatSync": { "name": "ChatSync", @@ -121,7 +121,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Starts or continues a non-streaming Amazon Q conversation.
" + "documentation": "Starts or continues a non-streaming Amazon Q Business conversation.
" }, "CreateApplication": { "name": "CreateApplication", @@ -159,7 +159,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Creates an Amazon Q application.
", + "documentation": "Creates an Amazon Q Business application.
", "idempotent": true }, "CreateDataSource": { @@ -198,7 +198,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Creates a data source connector for an Amazon Q application.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Creates a data source connector for an Amazon Q Business application.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Creates an Amazon Q index.
To determine if index creation has completed, check the Status
field returned from a call to DescribeIndex
. The Status
field is set to ACTIVE
when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument
API or the CreateDataSource
API.
Creates an Amazon Q Business index.
To determine if index creation has completed, check the Status
field returned from a call to DescribeIndex
. The Status
field is set to ACTIVE
when the index is ready to use.
Once the index is active, you can index your documents using the BatchPutDocument
API or the CreateDataSource
API.
Creates an Amazon Q plugin.
", + "documentation": "Creates an Amazon Q Business plugin.
", "idempotent": true }, "CreateRetriever": { @@ -314,7 +314,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Adds a retriever to your Amazon Q application.
" + "documentation": "Adds a retriever to your Amazon Q Business application.
" }, "CreateUser": { "name": "CreateUser", @@ -391,7 +391,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Creates an Amazon Q web experience.
" + "documentation": "Creates an Amazon Q Business web experience.
" }, "DeleteApplication": { "name": "DeleteApplication", @@ -426,7 +426,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes an Amazon Q application.
", + "documentation": "Deletes an Amazon Q Business application.
", "idempotent": true }, "DeleteChatControlsConfiguration": { @@ -459,7 +459,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes chat controls configured for an existing Amazon Q application.
", + "documentation": "Deletes chat controls configured for an existing Amazon Q Business application.
", "idempotent": true }, "DeleteConversation": { @@ -495,7 +495,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes an Amazon Q web experience conversation.
", + "documentation": "Deletes an Amazon Q Business web experience conversation.
", "idempotent": true }, "DeleteDataSource": { @@ -531,7 +531,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes an Amazon Q data source connector. While the data source is being deleted, the Status
field returned by a call to the DescribeDataSource
API is set to DELETING
.
Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status
field returned by a call to the DescribeDataSource
API is set to DELETING
.
Deletes an Amazon Q index.
", + "documentation": "Deletes an Amazon Q Business index.
", "idempotent": true }, "DeletePlugin": { @@ -639,7 +639,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes an Amazon Q plugin.
", + "documentation": "Deletes an Amazon Q Business plugin.
", "idempotent": true }, "DeleteRetriever": { @@ -675,7 +675,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes the retriever used by an Amazon Q application.
", + "documentation": "Deletes the retriever used by an Amazon Q Business application.
", "idempotent": true }, "DeleteUser": { @@ -747,7 +747,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Deletes an Amazon Q web experience.
", + "documentation": "Deletes an Amazon Q Business web experience.
", "idempotent": true }, "GetApplication": { @@ -780,7 +780,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing Amazon Q application.
" + "documentation": "Gets information about an existing Amazon Q Business application.
" }, "GetChatControlsConfiguration": { "name": "GetChatControlsConfiguration", @@ -812,7 +812,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an chat controls configured for an existing Amazon Q application.
" + "documentation": "Gets information about an chat controls configured for an existing Amazon Q Business application.
" }, "GetDataSource": { "name": "GetDataSource", @@ -844,7 +844,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing Amazon Q data source connector.
" + "documentation": "Gets information about an existing Amazon Q Business data source connector.
" }, "GetGroup": { "name": "GetGroup", @@ -911,7 +911,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing Amazon Q index.
" + "documentation": "Gets information about an existing Amazon Q Business index.
" }, "GetPlugin": { "name": "GetPlugin", @@ -943,7 +943,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing Amazon Q plugin.
" + "documentation": "Gets information about an existing Amazon Q Business plugin.
" }, "GetRetriever": { "name": "GetRetriever", @@ -975,7 +975,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing retriever used by an Amazon Q application.
" + "documentation": "Gets information about an existing retriever used by an Amazon Q Business application.
" }, "GetUser": { "name": "GetUser", @@ -1042,7 +1042,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets information about an existing Amazon Q web experience.
" + "documentation": "Gets information about an existing Amazon Q Business web experience.
" }, "ListApplications": { "name": "ListApplications", @@ -1071,7 +1071,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists Amazon Q applications.
" + "documentation": "Lists Amazon Q Business applications.
" }, "ListConversations": { "name": "ListConversations", @@ -1106,7 +1106,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists one or more Amazon Q conversations.
" + "documentation": "Lists one or more Amazon Q Business conversations.
" }, "ListDataSourceSyncJobs": { "name": "ListDataSourceSyncJobs", @@ -1138,7 +1138,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Get information about an Amazon Q data source connector synchronization.
" + "documentation": "Get information about an Amazon Q Business data source connector synchronization.
" }, "ListDataSources": { "name": "ListDataSources", @@ -1170,7 +1170,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists the Amazon Q data source connectors that you have created.
" + "documentation": "Lists the Amazon Q Business data source connectors that you have created.
" }, "ListDocuments": { "name": "ListDocuments", @@ -1269,7 +1269,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists the Amazon Q indices you have created.
" + "documentation": "Lists the Amazon Q Business indices you have created.
" }, "ListMessages": { "name": "ListMessages", @@ -1304,7 +1304,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets a list of messages associated with an Amazon Q web experience.
" + "documentation": "Gets a list of messages associated with an Amazon Q Business web experience.
" }, "ListPlugins": { "name": "ListPlugins", @@ -1336,7 +1336,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists configured Amazon Q plugins.
" + "documentation": "Lists configured Amazon Q Business plugins.
" }, "ListRetrievers": { "name": "ListRetrievers", @@ -1368,7 +1368,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists the retriever used by an Amazon Q application.
" + "documentation": "Lists the retriever used by an Amazon Q Business application.
" }, "ListTagsForResource": { "name": "ListTagsForResource", @@ -1400,7 +1400,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
" + "documentation": "Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
" }, "ListWebExperiences": { "name": "ListWebExperiences", @@ -1432,7 +1432,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Lists one or more Amazon Q Web Experiences.
" + "documentation": "Lists one or more Amazon Q Business Web Experiences.
" }, "PutFeedback": { "name": "PutFeedback", @@ -1461,7 +1461,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Enables your end user to to provide feedback on their Amazon Q generated chat responses.
" + "documentation": "Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
" }, "PutGroup": { "name": "PutGroup", @@ -1499,7 +1499,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q chat results.
", + "documentation": "Create, or updates, a mapping of users—who have access to a document—to groups.
You can also map sub groups to groups. For example, the group \"Company Intellectual Property Teams\" includes sub groups \"Research\" and \"Engineering\". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.
", "idempotent": true }, "StartDataSourceSyncJob": { @@ -1538,7 +1538,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException
.
Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException
.
Stops an Amazon Q data source connector synchronization job already in progress.
" + "documentation": "Stops an Amazon Q Business data source connector synchronization job already in progress.
" }, "TagResource": { "name": "TagResource", @@ -1605,7 +1605,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Adds the specified tag to the specified Amazon Q application or data source resource. If the tag already exists, the existing value is replaced with the new value.
", + "documentation": "Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.
", "idempotent": true }, "UntagResource": { @@ -1638,7 +1638,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Removes a tag from an Amazon Q application or a data source.
", + "documentation": "Removes a tag from an Amazon Q Business application or a data source.
", "idempotent": true }, "UpdateApplication": { @@ -1674,7 +1674,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Updates an existing Amazon Q application.
", + "documentation": "Updates an existing Amazon Q Business application.
", "idempotent": true }, "UpdateChatControlsConfiguration": { @@ -1713,7 +1713,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an set of chat controls configured for an existing Amazon Q application.
", + "documentation": "Updates an set of chat controls configured for an existing Amazon Q Business application.
", "idempotent": true }, "UpdateDataSource": { @@ -1749,7 +1749,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Updates an existing Amazon Q data source connector.
", + "documentation": "Updates an existing Amazon Q Business data source connector.
", "idempotent": true }, "UpdateIndex": { @@ -1788,7 +1788,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an Amazon Q index.
", + "documentation": "Updates an Amazon Q Business index.
", "idempotent": true }, "UpdatePlugin": { @@ -1827,7 +1827,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates an Amazon Q plugin.
", + "documentation": "Updates an Amazon Q Business plugin.
", "idempotent": true }, "UpdateRetriever": { @@ -1866,7 +1866,7 @@ "shape": "ServiceQuotaExceededException" } ], - "documentation": "Updates the retriever used for your Amazon Q application.
", + "documentation": "Updates the retriever used for your Amazon Q Business application.
", "idempotent": true }, "UpdateUser": { @@ -1938,7 +1938,7 @@ "shape": "AccessDeniedException" } ], - "documentation": "Updates an Amazon Q web experience.
", + "documentation": "Updates an Amazon Q Business web experience.
", "idempotent": true } }, @@ -1993,7 +1993,7 @@ "members": { "payload": { "shape": "ActionExecutionPayload", - "documentation": "A mapping of field names to the field values in input that an end user provides to Amazon Q requests to perform their plugin action.
" + "documentation": "A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.
" }, "payloadFieldNameSeparator": { "shape": "ActionPayloadFieldNameSeparator", @@ -2004,7 +2004,7 @@ "documentation": "The identifier of the plugin the action is attached to.
" } }, - "documentation": "Performs an Amazon Q plugin action during a non-streaming chat conversation.
" + "documentation": "Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
" }, "ActionExecutionPayload": { "type": "map", @@ -2056,7 +2056,7 @@ "members": { "payload": { "shape": "ActionReviewPayload", - "documentation": "Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.
" + "documentation": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" }, "payloadFieldNameSeparator": { "shape": "ActionPayloadFieldNameSeparator", @@ -2071,7 +2071,7 @@ "documentation": "The type of plugin.
" } }, - "documentation": "An output event that Amazon Q returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q.
" + "documentation": "An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.
" }, "ActionReviewPayload": { "type": "map", @@ -2087,7 +2087,7 @@ "members": { "allowedValues": { "shape": "ActionReviewPayloadFieldAllowedValues", - "documentation": "Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
" + "documentation": "Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" }, "displayName": { "shape": "String", @@ -2124,7 +2124,7 @@ "documentation": "The field value.
" } }, - "documentation": "Information about the field values that an end user can use to provide to Amazon Q for Amazon Q to perform the requested plugin action.
" + "documentation": "Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" }, "ActionReviewPayloadFieldAllowedValues": { "type": "list", @@ -2142,26 +2142,26 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier for the Amazon Q application.
" + "documentation": "The identifier for the Amazon Q Business application.
" }, "createdAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was created.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was created.
" }, "displayName": { "shape": "ApplicationName", - "documentation": "The name of the Amazon Q application.
" + "documentation": "The name of the Amazon Q Business application.
" }, "status": { "shape": "ApplicationStatus", - "documentation": "The status of the Amazon Q application. The application is ready to use when the status is ACTIVE
.
The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE
.
The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } }, - "documentation": "Summary information for an Amazon Q application.
" + "documentation": "Summary information for an Amazon Q Business application.
" }, "ApplicationArn": { "type": "string", @@ -2207,6 +2207,19 @@ }, "documentation": "Configuration information about the file upload during chat feature for your application.
" }, + "AppliedCreatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl", + "documentation": "Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
" + } + }, + "documentation": "The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.
For more information, see Admin controls and guardrails and Conversation settings.
" + }, "AttachmentInput": { "type": "structure", "required": [ @@ -2298,31 +2311,31 @@ }, "containsAll": { "shape": "DocumentAttribute", - "documentation": "Returns true
when a document contains all the specified document attributes or metadata fields.
Returns true
when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue
.
Returns true
when a document contains any of the specified document attributes or metadata fields.
Returns true
when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: dateValue
, longValue
, stringListValue
and stringValue
.
Performs an equals operation on two document attributes or metadata fields.
" + "documentation": "Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue
, longValue
, stringListValue
and stringValue
.
Performs a greater than operation on two document attributes or metadata fields. Use with a document attribute of type Date
or Long
.
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue
and longValue
.
Performs a greater or equals than operation on two document attributes or metadata fields. Use with a document attribute of type Date
or Long
.
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue
and longValue
.
Performs a less than operation on two document attributes or metadata fields. Use with a document attribute of type Date
or Long
.
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue
and longValue
.
Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date
or Long
.
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type: dateValue
and longValue
.
The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
" + "documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
" }, "secretArn": { "shape": "SecretArn", @@ -2384,7 +2397,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, @@ -2394,11 +2407,11 @@ }, "documents": { "shape": "DeleteDocuments", - "documentation": "Documents deleted from the Amazon Q index.
" + "documentation": "Documents deleted from the Amazon Q Business index.
" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index that contains the documents to delete.
", + "documentation": "The identifier of the Amazon Q Business index that contains the documents to delete.
", "location": "uri", "locationName": "indexId" } @@ -2409,7 +2422,7 @@ "members": { "failedDocuments": { "shape": "FailedDocuments", - "documentation": "A list of documents that couldn't be removed from the Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" + "documentation": "A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" } } }, @@ -2423,7 +2436,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, @@ -2437,7 +2450,7 @@ }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index to add the documents to.
", + "documentation": "The identifier of the Amazon Q Business index to add the documents to.
", "location": "uri", "locationName": "indexId" }, @@ -2452,7 +2465,7 @@ "members": { "failedDocuments": { "shape": "FailedDocuments", - "documentation": "A list of documents that were not added to the Amazon Q index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
" + "documentation": "A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
" } } }, @@ -2478,7 +2491,7 @@ "members": { "blockedPhrases": { "shape": "BlockedPhrases", - "documentation": "A list of phrases blocked from a Amazon Q web experience chat.
" + "documentation": "A list of phrases blocked from a Amazon Q Business web experience chat.
" }, "systemMessageOverride": { "shape": "SystemMessageOverride", @@ -2492,18 +2505,18 @@ "members": { "blockedPhrasesToCreateOrUpdate": { "shape": "BlockedPhrases", - "documentation": "Creates or updates a blocked phrases configuration in your Amazon Q application.
" + "documentation": "Creates or updates a blocked phrases configuration in your Amazon Q Business application.
" }, "blockedPhrasesToDelete": { "shape": "BlockedPhrases", - "documentation": "Deletes a blocked phrases configuration in your Amazon Q application.
" + "documentation": "Deletes a blocked phrases configuration in your Amazon Q Business application.
" }, "systemMessageOverride": { "shape": "SystemMessageOverride", "documentation": "The configured custom message displayed to your end user when they use blocked phrase during chat.
" } }, - "documentation": "Updates a blocked phrases configuration in your Amazon Q application.
" + "documentation": "Updates a blocked phrases configuration in your Amazon Q Business application.
" }, "Boolean": { "type": "boolean", @@ -2515,20 +2528,38 @@ "max": 999999999, "min": 0 }, + "ChatMode": { + "type": "string", + "enum": [ + "RETRIEVAL_MODE", + "CREATOR_MODE", + "PLUGIN_MODE" + ] + }, + "ChatModeConfiguration": { + "type": "structure", + "members": { + "pluginConfiguration": { + "shape": "PluginConfiguration", + "documentation": "Configuration information required to invoke chat in PLUGIN_MODE
.
Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
", + "union": true + }, "ChatSyncInput": { "type": "structure", "required": [ - "applicationId", - "userId" + "applicationId" ], "members": { "actionExecution": { "shape": "ActionExecution", - "documentation": "A request from an end user to perform an Amazon Q plugin action.
" + "documentation": "A request from an end user to perform an Amazon Q Business plugin action.
" }, "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the Amazon Q conversation.
", + "documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
", "location": "uri", "locationName": "applicationId" }, @@ -2538,7 +2569,15 @@ }, "attributeFilter": { "shape": "AttributeFilter", - "documentation": "Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
" + "documentation": "Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
" + }, + "chatMode": { + "shape": "ChatMode", + "documentation": "The chat modes available in an Amazon Q Business web experience.
RETRIEVAL_MODE
- The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.
CREATOR_MODE
- By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.
PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
" + }, + "chatModeConfiguration": { + "shape": "ChatModeConfiguration", + "documentation": "The chat mode configuration for an Amazon Q Business application.
" }, "clientToken": { "shape": "ClientToken", @@ -2547,7 +2586,7 @@ }, "conversationId": { "shape": "ConversationId", - "documentation": "The identifier of the Amazon Q conversation.
" + "documentation": "The identifier of the Amazon Q Business conversation.
" }, "parentMessageId": { "shape": "MessageId", @@ -2576,11 +2615,11 @@ "members": { "actionReview": { "shape": "ActionReview", - "documentation": "A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.
" + "documentation": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
" }, "conversationId": { "shape": "ConversationId", - "documentation": "The identifier of the Amazon Q conversation.
" + "documentation": "The identifier of the Amazon Q Business conversation.
" }, "failedAttachments": { "shape": "AttachmentsOutput", @@ -2596,11 +2635,11 @@ }, "systemMessageId": { "shape": "MessageId", - "documentation": "The identifier of an Amazon Q AI generated message within the conversation.
" + "documentation": "The identifier of an Amazon Q Business AI generated message within the conversation.
" }, "userMessageId": { "shape": "MessageId", - "documentation": "The identifier of an Amazon Q end user text input message within the conversation.
" + "documentation": "The identifier of an Amazon Q Business end user text input message within the conversation.
" } } }, @@ -2617,17 +2656,17 @@ "documentation": "The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.
" } }, - "documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
" + "documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. You can configure a custom message to inform your end users that they have asked about a restricted topic and suggest any next steps they should take.
" }, "ContentRetrievalRule": { "type": "structure", "members": { "eligibleDataSources": { "shape": "EligibleDataSources", - "documentation": "Specifies data sources in a Amazon Q application to use for content generation.
" + "documentation": "Specifies data sources in a Amazon Q Business application to use for content generation.
" } }, - "documentation": "Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.
" + "documentation": "Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
" }, "ContentType": { "type": "string", @@ -2651,7 +2690,7 @@ "members": { "conversationId": { "shape": "ConversationId", - "documentation": "The identifier of the Amazon Q conversation.
" + "documentation": "The identifier of the Amazon Q Business conversation.
" }, "startTime": { "shape": "Timestamp", @@ -2662,7 +2701,7 @@ "documentation": "The title of the conversation.
" } }, - "documentation": "A conversation in an Amazon Q application.
" + "documentation": "A conversation in an Amazon Q Business application.
" }, "ConversationId": { "type": "string", @@ -2692,20 +2731,24 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "A token that you provide to identify the request to create your Amazon Q application.
", + "documentation": "A token that you provide to identify the request to create your Amazon Q Business application.
", "idempotencyToken": true }, "description": { "shape": "Description", - "documentation": "A description for the Amazon Q application.
" + "documentation": "A description for the Amazon Q Business application.
" }, "displayName": { "shape": "ApplicationName", - "documentation": "A name for the Amazon Q application.
" + "documentation": "A name for the Amazon Q Business application.
" }, "encryptionConfiguration": { "shape": "EncryptionConfiguration", - "documentation": "The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
" + "documentation": "The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
" + }, + "identityCenterInstanceArn": { + "shape": "InstanceArn", + "documentation": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
" }, "roleArn": { "shape": "RoleArn", @@ -2713,7 +2756,7 @@ }, "tags": { "shape": "Tags", - "documentation": "A list of key-value pairs that identify or categorize your Amazon Q application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
" + "documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
" } } }, @@ -2722,11 +2765,11 @@ "members": { "applicationArn": { "shape": "ApplicationArn", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" }, "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
" + "documentation": "The identifier of the Amazon Q Business application.
" } } }, @@ -2741,7 +2784,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application the data source will be attached to.
", + "documentation": "The identifier of the Amazon Q Business application the data source will be attached to.
", "location": "uri", "locationName": "applicationId" }, @@ -2752,7 +2795,7 @@ }, "configuration": { "shape": "DataSourceConfiguration", - "documentation": "Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
" + "documentation": "Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
" }, "description": { "shape": "Description", @@ -2777,7 +2820,7 @@ }, "syncSchedule": { "shape": "SyncSchedule", - "documentation": "Sets the frequency for Amazon Q to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q won't periodically update the index.
Specify a cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a ValidationException
exception.
Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
Specify a cron-
format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a ValidationException
exception.
Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q connectors.
" + "documentation": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
" } } }, @@ -2794,7 +2837,7 @@ "members": { "dataSourceArn": { "shape": "DataSourceArn", - "documentation": "The Amazon Resource Name (ARN) of a data source in an Amazon Q application.
" + "documentation": "The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
" }, "dataSourceId": { "shape": "DataSourceId", @@ -2811,7 +2854,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application using the index.
", + "documentation": "The identifier of the Amazon Q Business application using the index.
", "location": "uri", "locationName": "applicationId" }, @@ -2826,11 +2869,11 @@ }, "description": { "shape": "Description", - "documentation": "A description for the Amazon Q index.
" + "documentation": "A description for the Amazon Q Business index.
" }, "displayName": { "shape": "IndexName", - "documentation": "A name for the Amazon Q index.
" + "documentation": "A name for the Amazon Q Business index.
" }, "tags": { "shape": "Tags", @@ -2843,11 +2886,11 @@ "members": { "indexArn": { "shape": "IndexArn", - "documentation": "The Amazon Resource Name (ARN) of an Amazon Q index.
" + "documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business index.
" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier for the Amazon Q index.
" + "documentation": "The identifier for the Amazon Q Business index.
" } } }, @@ -2872,7 +2915,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "A token that you provide to identify the request to create your Amazon Q plugin.
", + "documentation": "A token that you provide to identify the request to create your Amazon Q Business plugin.
", "idempotencyToken": true }, "displayName": { @@ -2917,13 +2960,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of your Amazon Q application.
", + "documentation": "The identifier of your Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, "clientToken": { "shape": "ClientToken", - "documentation": "A token that you provide to identify the request to create your Amazon Q application retriever.
", + "documentation": "A token that you provide to identify the request to create your Amazon Q Business application retriever.
", "idempotencyToken": true }, "configuration": { @@ -2935,7 +2978,7 @@ }, "roleArn": { "shape": "RoleArn", - "documentation": "The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
" + "documentation": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
" }, "tags": { "shape": "Tags", @@ -2975,7 +3018,7 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "A token that you provide to identify the request to create your Amazon Q user mapping.
", + "documentation": "A token that you provide to identify the request to create your Amazon Q Business user mapping.
", "idempotencyToken": true }, "userAliases": { @@ -3008,34 +3051,38 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q web experience.
", + "documentation": "The identifier of the Amazon Q Business web experience.
", "location": "uri", "locationName": "applicationId" }, "clientToken": { "shape": "ClientToken", - "documentation": "A token you provide to identify a request to create an Amazon Q web experience.
", + "documentation": "A token you provide to identify a request to create an Amazon Q Business web experience.
", "idempotencyToken": true }, + "roleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the service role attached to your web experience.
" + }, "samplePromptsControlMode": { "shape": "WebExperienceSamplePromptsControlMode", "documentation": "Determines whether sample prompts are enabled in the web experience for an end user.
" }, "subtitle": { "shape": "WebExperienceSubtitle", - "documentation": "A subtitle to personalize your Amazon Q web experience.
" + "documentation": "A subtitle to personalize your Amazon Q Business web experience.
" }, "tags": { "shape": "Tags", - "documentation": "A list of key-value pairs that identify or categorize your Amazon Q web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
" + "documentation": "A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
" }, "title": { "shape": "WebExperienceTitle", - "documentation": "The title for your Amazon Q web experience.
" + "documentation": "The title for your Amazon Q Business web experience.
" }, "welcomeMessage": { "shape": "WebExperienceWelcomeMessage", - "documentation": "The customized welcome message for end users of an Amazon Q web experience.
" + "documentation": "The customized welcome message for end users of an Amazon Q Business web experience.
" } } }, @@ -3044,43 +3091,63 @@ "members": { "webExperienceArn": { "shape": "WebExperienceArn", - "documentation": "The Amazon Resource Name (ARN) of an Amazon Q web experience.
" + "documentation": "The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of the Amazon Q web experience.
" + "documentation": "The identifier of the Amazon Q Business web experience.
" } } }, + "CreatorModeConfiguration": { + "type": "structure", + "required": [ + "creatorModeControl" + ], + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl", + "documentation": "Status information about whether CREATOR_MODE
has been enabled or disabled. The default status is DISABLED
.
Configuration information required to invoke chat in CREATOR_MODE
.
For more information, see Admin controls and guardrails and Conversation settings.
" + }, + "CreatorModeControl": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, "DataSource": { "type": "structure", "members": { "createdAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q data source was created.
" + "documentation": "The Unix timestamp when the Amazon Q Business data source was created.
" }, "dataSourceId": { "shape": "DataSourceId", - "documentation": "The identifier of the Amazon Q data source.
" + "documentation": "The identifier of the Amazon Q Business data source.
" }, "displayName": { "shape": "DataSourceName", - "documentation": "The name of the Amazon Q data source.
" + "documentation": "The name of the Amazon Q Business data source.
" }, "status": { "shape": "DataSourceStatus", - "documentation": "The status of the Amazon Q data source.
" + "documentation": "The status of the Amazon Q Business data source.
" }, "type": { "shape": "String", - "documentation": "The type of the Amazon Q data source.
" + "documentation": "The type of the Amazon Q Business data source.
" }, "updatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q data source was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business data source was last updated.
" } }, - "documentation": "A data source in an Amazon Q application.
" + "documentation": "A data source in an Amazon Q Business application.
" }, "DataSourceArn": { "type": "string", @@ -3091,7 +3158,7 @@ "DataSourceConfiguration": { "type": "structure", "members": {}, - "documentation": "Provides the configuration information for an Amazon Q data source.
", + "documentation": "Provides the configuration information for an Amazon Q Business data source.
", "document": true }, "DataSourceId": { @@ -3157,7 +3224,7 @@ "documentation": "The status of the synchronization job. When the Status
field is set to SUCCEEDED
, the synchronization job is done. If the status code is FAILED
, the ErrorCode
and ErrorMessage
fields give you the reason for the failure.
Provides information about an Amazon Q data source connector synchronization job.
" + "documentation": "Provides information about an Amazon Q Business data source connector synchronization job.
" }, "DataSourceSyncJobMetrics": { "type": "structure", @@ -3183,7 +3250,7 @@ "documentation": "The current count of documents crawled by the ongoing sync job in the data source.
" } }, - "documentation": "Maps a batch delete document request to a specific Amazon Q data source connector sync job.
" + "documentation": "Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
" }, "DataSourceSyncJobStatus": { "type": "string", @@ -3218,7 +3285,7 @@ "members": { "securityGroupIds": { "shape": "SecurityGroupIds", - "documentation": "A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q to connect to the data source.
" + "documentation": "A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
" }, "subnetIds": { "shape": "SubnetIds", @@ -3248,7 +3315,7 @@ "documentation": "Specifies how much a document attribute is boosted.
" } }, - "documentation": "Provides information on boosting DATE
type document attributes.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + "documentation": "Provides information on boosting DATE
type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
" }, "DeleteApplicationRequest": { "type": "structure", @@ -3258,7 +3325,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" } @@ -3290,19 +3357,18 @@ "type": "structure", "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application associated with the conversation.
", + "documentation": "The identifier of the Amazon Q Business application associated with the conversation.
", "location": "uri", "locationName": "applicationId" }, "conversationId": { "shape": "ConversationId", - "documentation": "The identifier of the Amazon Q web experience conversation being deleted.
", + "documentation": "The identifier of the Amazon Q Business web experience conversation being deleted.
", "location": "uri", "locationName": "conversationId" }, @@ -3328,7 +3394,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application used with the data source connector.
", + "documentation": "The identifier of the Amazon Q Business application used with the data source connector.
", "location": "uri", "locationName": "applicationId" }, @@ -3361,7 +3427,7 @@ "documentation": "The identifier of the deleted document.
" } }, - "documentation": "A document deleted from an Amazon Q data source connector.
" + "documentation": "A document deleted from an Amazon Q Business data source connector.
" }, "DeleteDocuments": { "type": "list", @@ -3416,13 +3482,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application the Amazon Q index is linked to.
", + "documentation": "The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
", "location": "uri", "locationName": "applicationId" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index.
", + "documentation": "The identifier of the Amazon Q Business index.
", "location": "uri", "locationName": "indexId" } @@ -3441,7 +3507,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier the application attached to the Amazon Q plugin.
", + "documentation": "The identifier the application attached to the Amazon Q Business plugin.
", "location": "uri", "locationName": "applicationId" }, @@ -3466,7 +3532,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application using the retriever.
", + "documentation": "The identifier of the Amazon Q Business application using the retriever.
", "location": "uri", "locationName": "applicationId" }, @@ -3516,13 +3582,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the Amazon Q web experience.
", + "documentation": "The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
", "location": "uri", "locationName": "applicationId" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of the Amazon Q web experience being deleted.
", + "documentation": "The identifier of the Amazon Q Business web experience being deleted.
", "location": "uri", "locationName": "webExperienceId" } @@ -3550,7 +3616,7 @@ }, "attributes": { "shape": "DocumentAttributes", - "documentation": "Custom attributes to apply to the document for refining Amazon Q web experience responses.
" + "documentation": "Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
" }, "content": { "shape": "DocumentContent", @@ -3573,7 +3639,7 @@ "documentation": "The title of the document.
" } }, - "documentation": "A document in an Amazon Q application.
" + "documentation": "A document in an Amazon Q Business application.
" }, "DocumentAttribute": { "type": "structure", @@ -3613,7 +3679,7 @@ "documentation": "Provides information on boosting STRING_LIST
type document attributes.
Provides information on boosting supported Amazon Q document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q prioritizes generating responses from content that matches the boosted document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
", + "documentation": "Provides information on boosting supported Amazon Q Business document attribute types. When an end user chat query matches document attributes that have been boosted, Amazon Q Business prioritizes generating responses from content that matches the boosted document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
", "union": true }, "DocumentAttributeBoostingLevel": { @@ -3645,7 +3711,7 @@ "members": { "key": { "shape": "DocumentAttributeKey", - "documentation": "The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q currently doesn't support _document_body
as an attribute key used for the condition.
The identifier of the document attribute used for the condition.
For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.
Amazon Q Business currently doesn't support _document_body
as an attribute key used for the condition.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q. You use this with DocumentAttributeTarget
to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q then will map your newly created metadata field to your index field.
The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget
to apply the condition.
For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q Business then will map your newly created metadata field to your index field.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition
.
The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE
. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.
Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget
. Amazon Q Business will then map your newly created document attribute to your index field.
You can also use this with DocumentAttributeCondition
.
The contents of the document. Documents passed to the blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the Amazon Q endpoint directly using REST, you must base64 encode the contents before sending.
The contents of the document. Documents passed to the blob
parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.
The timestamp for when the document was last updated.
" } }, - "documentation": "The details of a document within an Amazon Q index.
" + "documentation": "The details of a document within an Amazon Q Business index.
" }, "DocumentEnrichmentConditionOperator": { "type": "string", @@ -3825,7 +3891,7 @@ "members": { "inlineConfigurations": { "shape": "InlineDocumentEnrichmentConfigurations", - "documentation": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.
" + "documentation": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
" }, "postExtractionHookConfiguration": { "shape": "HookConfiguration" @@ -3875,7 +3941,7 @@ "documentation": "The identifier of the index the data source is attached to.
" } }, - "documentation": "The identifier of the data source Amazon Q will generate responses from.
" + "documentation": "The identifier of the data source Amazon Q Business will generate responses from.
" }, "EligibleDataSources": { "type": "list", @@ -3890,10 +3956,10 @@ "members": { "kmsKeyId": { "shape": "KmsKeyId", - "documentation": "The identifier of the KMS key. Amazon Q doesn't support asymmetric keys.
" + "documentation": "The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
" } }, - "documentation": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.
" + "documentation": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
" }, "ErrorCode": { "type": "string", @@ -3949,7 +4015,7 @@ "members": { "dataSourceId": { "shape": "DataSourceId", - "documentation": "The identifier of the Amazon Q data source connector that contains the failed document.
" + "documentation": "The identifier of the Amazon Q Business data source connector that contains the failed document.
" }, "error": { "shape": "ErrorDetail", @@ -3957,10 +4023,10 @@ }, "id": { "shape": "DocumentId", - "documentation": "The identifier of the document that couldn't be removed from the Amazon Q index.
" + "documentation": "The identifier of the document that couldn't be removed from the Amazon Q Business index.
" } }, - "documentation": "A list of documents that could not be removed from an Amazon Q index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" + "documentation": "A list of documents that could not be removed from an Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" }, "FailedDocuments": { "type": "list", @@ -3976,7 +4042,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" } @@ -3987,11 +4053,11 @@ "members": { "applicationArn": { "shape": "ApplicationArn", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" }, "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
" + "documentation": "The identifier of the Amazon Q Business application.
" }, "attachmentsConfiguration": { "shape": "AppliedAttachmentsConfiguration", @@ -3999,35 +4065,39 @@ }, "createdAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" }, "description": { "shape": "Description", - "documentation": "A description for the Amazon Q application.
" + "documentation": "A description for the Amazon Q Business application.
" }, "displayName": { "shape": "ApplicationName", - "documentation": "The name of the Amazon Q application.
" + "documentation": "The name of the Amazon Q Business application.
" }, "encryptionConfiguration": { "shape": "EncryptionConfiguration", - "documentation": "The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
" + "documentation": "The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
" }, "error": { "shape": "ErrorDetail", "documentation": "If the Status
field is set to ERROR
, the ErrorMessage
field contains a description of the error that caused the synchronization to fail.
The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
" + }, "roleArn": { "shape": "RoleArn", "documentation": "The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
" }, "status": { "shape": "ApplicationStatus", - "documentation": "The status of the Amazon Q application.
" + "documentation": "The status of the Amazon Q Business application.
" }, "updatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" } } }, @@ -4051,7 +4121,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
The phrases blocked from chat by your chat control configuration.
" }, + "creatorModeConfiguration": { + "shape": "AppliedCreatorModeConfiguration", + "documentation": "The configuration details for CREATOR_MODE
.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q chat controls configured.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.
The response scope configured for a Amazon Q application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
" + "documentation": "The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
" }, "topicConfigurations": { "shape": "TopicConfigurations", - "documentation": "The topic specific controls configured for a Amazon Q application.
" + "documentation": "The topic specific controls configured for a Amazon Q Business application.
" } } }, @@ -4088,7 +4162,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, @@ -4111,7 +4185,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
" + "documentation": "The identifier of the Amazon Q Business application.
" }, "configuration": { "shape": "DataSourceConfiguration", @@ -4158,7 +4232,7 @@ }, "syncSchedule": { "shape": "SyncSchedule", - "documentation": "The schedule for Amazon Q to update the index.
" + "documentation": "The schedule for Amazon Q Business to update the index.
" }, "type": { "shape": "String", @@ -4230,13 +4304,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application connected to the index.
", + "documentation": "The identifier of the Amazon Q Business application connected to the index.
", "location": "uri", "locationName": "applicationId" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index you want information on.
", + "documentation": "The identifier of the Amazon Q Business index you want information on.
", "location": "uri", "locationName": "indexId" } @@ -4247,23 +4321,23 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application associated with the index.
" + "documentation": "The identifier of the Amazon Q Business application associated with the index.
" }, "capacityConfiguration": { "shape": "IndexCapacityConfiguration", - "documentation": "The storage capacity units chosen for your Amazon Q index.
" + "documentation": "The storage capacity units chosen for your Amazon Q Business index.
" }, "createdAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q index was created.
" + "documentation": "The Unix timestamp when the Amazon Q Business index was created.
" }, "description": { "shape": "Description", - "documentation": "The description for the Amazon Q index.
" + "documentation": "The description for the Amazon Q Business index.
" }, "displayName": { "shape": "IndexName", - "documentation": "The name of the Amazon Q index.
" + "documentation": "The name of the Amazon Q Business index.
" }, "documentAttributeConfigurations": { "shape": "DocumentAttributeConfigurations", @@ -4275,11 +4349,11 @@ }, "indexArn": { "shape": "IndexArn", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q index.
" + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business index.
" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index.
" + "documentation": "The identifier of the Amazon Q Business index.
" }, "indexStatistics": { "shape": "IndexStatistics", @@ -4291,7 +4365,7 @@ }, "updatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q index was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business index was last updated.
" } } }, @@ -4369,7 +4443,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application using the retriever.
", + "documentation": "The identifier of the Amazon Q Business application using the retriever.
", "location": "uri", "locationName": "applicationId" }, @@ -4386,7 +4460,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application using the retriever.
" + "documentation": "The identifier of the Amazon Q Business application using the retriever.
" }, "configuration": { "shape": "RetrieverConfiguration" @@ -4464,13 +4538,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the web experience.
", + "documentation": "The identifier of the Amazon Q Business application linked to the web experience.
", "location": "uri", "locationName": "applicationId" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of the Amazon Q web experience.
", + "documentation": "The identifier of the Amazon Q Business web experience.
", "location": "uri", "locationName": "webExperienceId" } @@ -4481,11 +4555,11 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the web experience.
" + "documentation": "The identifier of the Amazon Q Business application linked to the web experience.
" }, "authenticationConfiguration": { "shape": "WebExperienceAuthConfiguration", - "documentation": "The authentication configuration information for your Amazon Q web experience.
" + "documentation": "The authentication configuration information for your Amazon Q Business web experience.
" }, "createdAt": { "shape": "Timestamp", @@ -4493,27 +4567,31 @@ }, "defaultEndpoint": { "shape": "Url", - "documentation": "The endpoint of your Amazon Q web experience.
" + "documentation": "The endpoint of your Amazon Q Business web experience.
" }, "error": { "shape": "ErrorDetail", "documentation": "When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source connector to fail.
The Amazon Resource Name (ARN) of the service role attached to your web experience.
" + }, "samplePromptsControlMode": { "shape": "WebExperienceSamplePromptsControlMode", "documentation": "Determines whether sample prompts are enabled in the web experience for an end user.
" }, "status": { "shape": "WebExperienceStatus", - "documentation": "The current status of the Amazon Q web experience. When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source connector to fail.
The current status of the Amazon Q Business web experience. When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source connector to fail.
The subtitle for your Amazon Q web experience.
" + "documentation": "The subtitle for your Amazon Q Business web experience.
" }, "title": { "shape": "WebExperienceTitle", - "documentation": "The title for your Amazon Q web experience.
" + "documentation": "The title for your Amazon Q Business web experience.
" }, "updatedAt": { "shape": "Timestamp", @@ -4521,15 +4599,15 @@ }, "webExperienceArn": { "shape": "WebExperienceArn", - "documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
" + "documentation": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of the Amazon Q web experience.
" + "documentation": "The identifier of the Amazon Q Business web experience.
" }, "welcomeMessage": { "shape": "WebExperienceWelcomeMessage", - "documentation": "The customized welcome message for end users of an Amazon Q web experience.
" + "documentation": "The customized welcome message for end users of an Amazon Q Business web experience.
" } } }, @@ -4545,7 +4623,7 @@ "documentation": "A list of users that belong to a group. For example, a list of interns all belong to the \"Interns\" group.
" } }, - "documentation": "A list of users or sub groups that belong to a group. This is for generating Amazon Q chat results only from document a user has access to.
" + "documentation": "A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.
" }, "GroupName": { "type": "string", @@ -4572,7 +4650,7 @@ }, "lastUpdatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" }, "status": { "shape": "GroupStatus", @@ -4608,7 +4686,7 @@ "members": { "invocationCondition": { "shape": "DocumentAttributeCondition", - "documentation": "The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q should invoke a function that inserts the current date-time.
" + "documentation": "The condition used for when a Lambda function should be invoked.
For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
" }, "lambdaArn": { "shape": "LambdaArn", @@ -4623,7 +4701,13 @@ "documentation": "Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
" } }, - "documentation": "Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.
You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
" + "documentation": "Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
" + }, + "IdcApplicationArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}$" }, "Index": { "type": "structure", @@ -4649,7 +4733,7 @@ "documentation": "The Unix timestamp when the index was last updated.
" } }, - "documentation": "Summary information for your Amazon Q index.
" + "documentation": "Summary information for your Amazon Q Business index.
" }, "IndexArn": { "type": "string", @@ -4662,7 +4746,7 @@ "members": { "units": { "shape": "IndexCapacityInteger", - "documentation": "The number of storage units configured for an Amazon Q index.
" + "documentation": "The number of storage units configured for an Amazon Q Business index.
" } }, "documentation": "Provides information about index capacity configuration.
" @@ -4734,7 +4818,7 @@ "shape": "DocumentAttributeTarget" } }, - "documentation": "Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration
.
For more information, see Custom document enrichment.
" + "documentation": "Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration
.
For more information, see Custom document enrichment.
" }, "InlineDocumentEnrichmentConfigurations": { "type": "list", @@ -4744,6 +4828,12 @@ "max": 100, "min": 1 }, + "InstanceArn": { + "type": "string", + "max": 1224, + "min": 10, + "pattern": "^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$" + }, "Integer": { "type": "integer", "box": true @@ -4784,13 +4874,13 @@ "members": { "maxResults": { "shape": "MaxResultsIntegerForListApplications", - "documentation": "The maximum number of Amazon Q applications to return.
", + "documentation": "The maximum number of Amazon Q Business applications to return.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.
An array of summary information on the configuration of one or more Amazon Q applications.
" + "documentation": "An array of summary information on the configuration of one or more Amazon Q Business applications.
" }, "nextToken": { "shape": "NextToken", - "documentation": "If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.
" } } }, "ListConversationsRequest": { "type": "structure", "required": [ - "applicationId", - "userId" + "applicationId" ], "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, "maxResults": { "shape": "MaxResultsIntegerForListConversations", - "documentation": "The maximum number of Amazon Q conversations to return.
", + "documentation": "The maximum number of Amazon Q Business conversations to return.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
The identifier of the user involved in the Amazon Q web experience conversation.
", + "documentation": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", "location": "querystring", "locationName": "userId" } @@ -4847,11 +4936,11 @@ "members": { "conversations": { "shape": "Conversations", - "documentation": "An array of summary information on the configuration of one or more Amazon Q web experiences.
" + "documentation": "An array of summary information on the configuration of one or more Amazon Q Business web experiences.
" }, "nextToken": { "shape": "NextToken", - "documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
" } } }, @@ -4865,7 +4954,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application connected to the data source.
", + "documentation": "The identifier of the Amazon Q Business application connected to the data source.
", "location": "uri", "locationName": "applicationId" }, @@ -4883,7 +4972,7 @@ }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "location": "uri", "locationName": "indexId" }, @@ -4895,7 +4984,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incpmplete because there is more data to retriever, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.
If the maxResults
response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.
If the response is truncated, Amazon Q returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
" } } }, @@ -4935,7 +5024,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the data source connectors.
", + "documentation": "The identifier of the Amazon Q Business application linked to the data source connectors.
", "location": "uri", "locationName": "applicationId" }, @@ -4953,7 +5042,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q data source connectors.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business data source connectors.
If the response is truncated, Amazon Q returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
" } } }, @@ -5005,7 +5094,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.
If the previous response was incomplete (because there is more data to retrieve), Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
", + "documentation": "If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
", "location": "querystring", "locationName": "nextToken" }, @@ -5079,7 +5168,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.
" } } }, @@ -5091,7 +5180,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application connected to the index.
", + "documentation": "The identifier of the Amazon Q Business application connected to the index.
", "location": "uri", "locationName": "applicationId" }, @@ -5103,7 +5192,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q indices.
", + "documentation": "If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business indices.
", "location": "querystring", "locationName": "nextToken" } @@ -5118,7 +5207,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the response is truncated, Amazon Q returns this token that you can use in the subsequent request to retrieve the next set of indexes.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.
" } } }, @@ -5126,19 +5215,18 @@ "type": "structure", "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier for the Amazon Q application.
", + "documentation": "The identifier for the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, "conversationId": { "shape": "ConversationId", - "documentation": "The identifier of the Amazon Q web experience conversation.
", + "documentation": "The identifier of the Amazon Q Business web experience conversation.
", "location": "uri", "locationName": "conversationId" }, @@ -5150,13 +5238,13 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the number of retrievers returned exceeds maxResults
, Amazon Q returns a next token as a pagination token to retrieve the next set of messages.
If the number of retrievers returned exceeds maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
The identifier of the user involved in the Amazon Q web experience conversation.
", + "documentation": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", "location": "querystring", "locationName": "userId" } @@ -5171,7 +5259,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
" } } }, @@ -5195,7 +5283,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
The identifier of the Amazon Q application using the retriever.
", + "documentation": "The identifier of the Amazon Q Business application using the retriever.
", "location": "uri", "locationName": "applicationId" }, @@ -5234,7 +5322,7 @@ }, "nextToken": { "shape": "NextToken", - "documentation": "If the number of retrievers returned exceeds maxResults
, Amazon Q returns a next token as a pagination token to retrieve the next set of retrievers.
If the number of retrievers returned exceeds maxResults
, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.
If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of retrievers.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of retrievers.
" }, "retrievers": { "shape": "Retrievers", @@ -5261,7 +5349,7 @@ "members": { "resourceARN": { "shape": "AmazonResourceName", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.
", + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
", "location": "uri", "locationName": "resourceARN" } @@ -5272,7 +5360,7 @@ "members": { "tags": { "shape": "Tags", - "documentation": "A list of tags associated with the Amazon Q application or data source.
" + "documentation": "A list of tags associated with the Amazon Q Business application or data source.
" } } }, @@ -5284,19 +5372,19 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application linked to the listed web experiences.
", + "documentation": "The identifier of the Amazon Q Business application linked to the listed web experiences.
", "location": "uri", "locationName": "applicationId" }, "maxResults": { "shape": "MaxResultsIntegerForListWebExperiencesRequest", - "documentation": "The maximum number of Amazon Q Web Experiences to return.
", + "documentation": "The maximum number of Amazon Q Business Web Experiences to return.
", "location": "querystring", "locationName": "maxResults" }, "nextToken": { "shape": "NextToken", - "documentation": "If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q conversations.
If the maxResults
response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.
If the response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
" + "documentation": "If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.
" }, "webExperiences": { "shape": "WebExperiences", - "documentation": "An array of summary information for one or more Amazon Q experiences.
" + "documentation": "An array of summary information for one or more Amazon Q Business experiences.
" } } }, @@ -5466,30 +5554,30 @@ }, "attachments": { "shape": "AttachmentsOutput", - "documentation": "A file directly uploaded into an Amazon Q web experience chat.
" + "documentation": "A file directly uploaded into an Amazon Q Business web experience chat.
" }, "body": { "shape": "MessageBody", - "documentation": "The content of the Amazon Q web experience message.
" + "documentation": "The content of the Amazon Q Business web experience message.
" }, "messageId": { "shape": "String", - "documentation": "The identifier of the Amazon Q web experience message.
" + "documentation": "The identifier of the Amazon Q Business web experience message.
" }, "sourceAttribution": { "shape": "SourceAttributions", - "documentation": "The source documents used to generate Amazon Q web experience message.
" + "documentation": "The source documents used to generate Amazon Q Business web experience message.
" }, "time": { "shape": "Timestamp", - "documentation": "The timestamp of the first Amazon Q web experience message.
" + "documentation": "The timestamp of the first Amazon Q Business web experience message.
" }, "type": { "shape": "MessageType", - "documentation": "The type of Amazon Q message, whether HUMAN
or AI
generated.
The type of Amazon Q Business message, whether HUMAN
or AI
generated.
A message in an Amazon Q web experience.
" + "documentation": "A message in an Amazon Q Business web experience.
" }, "MessageBody": { "type": "string", @@ -5584,14 +5672,14 @@ "members": { "boostingOverride": { "shape": "DocumentAttributeBoostingOverrideMap", - "documentation": "Overrides the default boosts applied by Amazon Q to supported document attribute data types.
" + "documentation": "Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
" }, "indexId": { "shape": "IndexId", - "documentation": "The identifier for the Amazon Q index.
" + "documentation": "The identifier for the Amazon Q Business index.
" } }, - "documentation": "Configuration information for an Amazon Q index.
" + "documentation": "Configuration information for an Amazon Q Business index.
" }, "NextToken": { "type": "string", @@ -5613,7 +5701,7 @@ "documentation": "Specifies how much a document attribute is boosted.
" } }, - "documentation": "Provides information on boosting NUMBER
type document attributes.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + "documentation": "Provides information on boosting NUMBER
type document attributes.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
" }, "NumberAttributeBoostingType": { "type": "string", @@ -5631,7 +5719,7 @@ "members": { "roleArn": { "shape": "RoleArn", - "documentation": "The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
" + "documentation": "The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
" }, "secretArn": { "shape": "SecretArn", @@ -5672,7 +5760,7 @@ "documentation": "The timestamp for when the plugin was last updated.
" } }, - "documentation": "Information about an Amazon Q plugin and its configuration.
" + "documentation": "Information about an Amazon Q Business plugin and its configuration.
" }, "PluginArn": { "type": "string", @@ -5692,9 +5780,22 @@ "documentation": "Information about the OAuth 2.0 authentication credential/token used to configure a plugin.
" } }, - "documentation": "Authentication configuration information for an Amazon Q plugin.
", + "documentation": "Authentication configuration information for an Amazon Q Business plugin.
", "union": true }, + "PluginConfiguration": { + "type": "structure", + "required": [ + "pluginId" + ], + "members": { + "pluginId": { + "shape": "PluginId", + "documentation": "The identifier of the plugin you want to use.
" + } + }, + "documentation": "Configuration information required to invoke chat in PLUGIN_MODE
.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
" + }, "PluginId": { "type": "string", "max": 36, @@ -5741,7 +5842,7 @@ "documentation": "The user associated with the principal.
" } }, - "documentation": "Provides user and group information used for filtering documents to use for generating Amazon Q conversation responses.
", + "documentation": "Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
", "union": true }, "PrincipalGroup": { @@ -5797,8 +5898,7 @@ "required": [ "applicationId", "conversationId", - "messageId", - "userId" + "messageId" ], "members": { "applicationId": { @@ -5897,7 +5997,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application using the retriever.
" + "documentation": "The identifier of the Amazon Q Business application using the retriever.
" }, "displayName": { "shape": "RetrieverName", @@ -5905,7 +6005,7 @@ }, "retrieverId": { "shape": "RetrieverId", - "documentation": "The identifier of the retriever used by your Amazon Q application.
" + "documentation": "The identifier of the retriever used by your Amazon Q Business application.
" }, "status": { "shape": "RetrieverStatus", @@ -5916,7 +6016,7 @@ "documentation": "The type of your retriever.
" } }, - "documentation": "Summary information for the retriever used for your Amazon Q application.
" + "documentation": "Summary information for the retriever used for your Amazon Q Business application.
" }, "RetrieverArn": { "type": "string", @@ -5929,14 +6029,14 @@ "members": { "kendraIndexConfiguration": { "shape": "KendraIndexConfiguration", - "documentation": "Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.
" + "documentation": "Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
" }, "nativeIndexConfiguration": { "shape": "NativeIndexConfiguration", - "documentation": "Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.
" + "documentation": "Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
" } }, - "documentation": "Provides information on how the retriever used for your Amazon Q application is configured.
", + "documentation": "Provides information on how the retriever used for your Amazon Q Business application is configured.
", "union": true }, "RetrieverId": { @@ -6001,14 +6101,14 @@ "documentation": "The type of rule.
" } }, - "documentation": "Guardrail rules for an Amazon Q application. Amazon Q supports only one rule at a time.
" + "documentation": "Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
" }, "RuleConfiguration": { "type": "structure", "members": { "contentBlockerRule": { "shape": "ContentBlockerRule", - "documentation": "A rule for configuring how Amazon Q responds when it encounters a a blocked topic.
" + "documentation": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
" }, "contentRetrievalRule": { "shape": "ContentRetrievalRule" @@ -6048,7 +6148,7 @@ "documentation": "The name of the file.
" } }, - "documentation": "Information required for Amazon Q to find a specific file in an Amazon S3 bucket.
" + "documentation": "Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
" }, "S3BucketName": { "type": "string", @@ -6080,7 +6180,7 @@ }, "roleArn": { "shape": "RoleArn", - "documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q web experience, containing the relevant Amazon Q permissions for conversing with Amazon Q.
" + "documentation": "The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.
" }, "userGroupAttribute": { "shape": "SamlAttribute", @@ -6091,7 +6191,7 @@ "documentation": "The user attribute name in your IdP that maps to the user email.
" } }, - "documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.
" + "documentation": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
" }, "SamlMetadataXML": { "type": "string", @@ -6124,7 +6224,7 @@ "members": { "citationNumber": { "shape": "Integer", - "documentation": "The number attached to a citation in an Amazon Q generated response.
" + "documentation": "The number attached to a citation in an Amazon Q Business generated response.
" }, "snippet": { "shape": "String", @@ -6136,18 +6236,18 @@ }, "title": { "shape": "String", - "documentation": "The title of the document which is the source for the Amazon Q generated response.
" + "documentation": "The title of the document which is the source for the Amazon Q Business generated response.
" }, "updatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" }, "url": { "shape": "String", - "documentation": "The URL of the document which is the source for the Amazon Q generated response.
" + "documentation": "The URL of the document which is the source for the Amazon Q Business generated response.
" } }, - "documentation": "The documents used to generate an Amazon Q web experience response.
" + "documentation": "The documents used to generate an Amazon Q Business web experience response.
" }, "SourceAttributions": { "type": "list", @@ -6165,7 +6265,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of Amazon Q application the data source is connected to.
", + "documentation": "The identifier of Amazon Q Business application the data source is connected to.
", "location": "uri", "locationName": "applicationId" }, @@ -6209,7 +6309,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application that the data source is connected to.
", + "documentation": "The identifier of the Amazon Q Business application that the data source is connected to.
", "location": "uri", "locationName": "applicationId" }, @@ -6221,7 +6321,7 @@ }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the index used with the Amazon Q data source connector.
", + "documentation": "The identifier of the index used with the Amazon Q Business data source connector.
", "location": "uri", "locationName": "indexId" } @@ -6251,7 +6351,7 @@ "documentation": "Specifies how much a document attribute is boosted.
" } }, - "documentation": "Provides information on boosting STRING
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + "documentation": "Provides information on boosting STRING
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
" }, "StringAttributeValueBoosting": { "type": "map", @@ -6284,7 +6384,7 @@ "documentation": "Specifies how much a document attribute is boosted.
" } }, - "documentation": "Provides information on boosting STRING_LIST
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q, see Boosting using document attributes.
" + "documentation": "Provides information on boosting STRING_LIST
type document attributes.
For STRING
and STRING_LIST
type document attributes to be used for boosting on the console and the API, they must be enabled for search using the DocumentAttributeConfiguration object of the UpdateIndex API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.
For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.
" }, "SubnetId": { "type": "string", @@ -6325,7 +6425,7 @@ "members": { "key": { "shape": "TagKey", - "documentation": "The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.
" + "documentation": "The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
" }, "value": { "shape": "TagValue", @@ -6356,13 +6456,13 @@ "members": { "resourceARN": { "shape": "AmazonResourceName", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.
", + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
", "location": "uri", "locationName": "resourceARN" }, "tags": { "shape": "Tags", - "documentation": "A list of tag keys to add to the Amazon Q application or data source. If a tag already exists, the existing value is replaced with the new value.
" + "documentation": "A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.
" } } }, @@ -6449,7 +6549,7 @@ "documentation": "Rules defined for a topic configuration.
" } }, - "documentation": "The topic specific controls configured for an Amazon Q application.
" + "documentation": "The topic specific controls configured for an Amazon Q Business application.
" }, "TopicConfigurationName": { "type": "string", @@ -6480,13 +6580,13 @@ "members": { "resourceARN": { "shape": "AmazonResourceName", - "documentation": "The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.
", + "documentation": "The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
", "location": "uri", "locationName": "resourceARN" }, "tagKeys": { "shape": "TagKeys", - "documentation": "A list of tag keys to remove from the Amazon Q application or data source. If a tag key does not exist on the resource, it is ignored.
", + "documentation": "A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.
", "location": "querystring", "locationName": "tagKeys" } @@ -6504,7 +6604,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application.
", + "documentation": "The identifier of the Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, @@ -6514,15 +6614,15 @@ }, "description": { "shape": "Description", - "documentation": "A description for the Amazon Q application.
" + "documentation": "A description for the Amazon Q Business application.
" }, "displayName": { "shape": "ApplicationName", - "documentation": "A name for the Amazon Q application.
" + "documentation": "A name for the Amazon Q Business application.
" }, "roleArn": { "shape": "RoleArn", - "documentation": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q permission to access Amazon CloudWatch logs and metrics.
" + "documentation": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
" } } }, @@ -6548,9 +6648,13 @@ }, "clientToken": { "shape": "ClientToken", - "documentation": "A token that you provide to identify the request to update a Amazon Q application chat configuration.
", + "documentation": "A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
", "idempotencyToken": true }, + "creatorModeConfiguration": { + "shape": "CreatorModeConfiguration", + "documentation": "The configuration details for CREATOR_MODE
.
The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
" @@ -6579,7 +6683,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application the data source is attached to.
", + "documentation": "The identifier of the Amazon Q Business application the data source is attached to.
", "location": "uri", "locationName": "applicationId" }, @@ -6635,21 +6739,21 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application connected to the index.
", + "documentation": "The identifier of the Amazon Q Business application connected to the index.
", "location": "uri", "locationName": "applicationId" }, "capacityConfiguration": { "shape": "IndexCapacityConfiguration", - "documentation": "The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.
" + "documentation": "The storage capacity units you want to provision for your Amazon Q Business index. You can add and remove capacity to fit your usage needs.
" }, "description": { "shape": "Description", - "documentation": "The description of the Amazon Q index.
" + "documentation": "The description of the Amazon Q Business index.
" }, "displayName": { "shape": "ApplicationName", - "documentation": "The name of the Amazon Q index.
" + "documentation": "The name of the Amazon Q Business index.
" }, "documentAttributeConfigurations": { "shape": "DocumentAttributeConfigurations", @@ -6657,7 +6761,7 @@ }, "indexId": { "shape": "IndexId", - "documentation": "The identifier of the Amazon Q index.
", + "documentation": "The identifier of the Amazon Q Business index.
", "location": "uri", "locationName": "indexId" } @@ -6717,7 +6821,7 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of your Amazon Q application.
", + "documentation": "The identifier of your Amazon Q Business application.
", "location": "uri", "locationName": "applicationId" }, @@ -6799,13 +6903,13 @@ "members": { "applicationId": { "shape": "ApplicationId", - "documentation": "The identifier of the Amazon Q application attached to the web experience.
", + "documentation": "The identifier of the Amazon Q Business application attached to the web experience.
", "location": "uri", "locationName": "applicationId" }, "authenticationConfiguration": { "shape": "WebExperienceAuthConfiguration", - "documentation": "The authentication configuration of the Amazon Q web experience.
" + "documentation": "The authentication configuration of the Amazon Q Business web experience.
" }, "samplePromptsControlMode": { "shape": "WebExperienceSamplePromptsControlMode", @@ -6813,21 +6917,21 @@ }, "subtitle": { "shape": "WebExperienceSubtitle", - "documentation": "The subtitle of the Amazon Q web experience.
" + "documentation": "The subtitle of the Amazon Q Business web experience.
" }, "title": { "shape": "WebExperienceTitle", - "documentation": "The title of the Amazon Q web experience.
" + "documentation": "The title of the Amazon Q Business web experience.
" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of the Amazon Q web experience.
", + "documentation": "The identifier of the Amazon Q Business web experience.
", "location": "uri", "locationName": "webExperienceId" }, "welcomeMessage": { "shape": "WebExperienceWelcomeMessage", - "documentation": "A customized welcome message for an end user in an Amazon Q web experience.
" + "documentation": "A customized welcome message for an end user in an Amazon Q Business web experience.
" } } }, @@ -6860,7 +6964,7 @@ "documentation": "The identifier of the user id associated with the user aliases.
" } }, - "documentation": "Aliases attached to a user id within an Amazon Q application.
" + "documentation": "Aliases attached to a user id within an Amazon Q Business application.
" }, "UserAliases": { "type": "list", @@ -6910,26 +7014,26 @@ "members": { "createdAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when the Amazon Q application was last updated.
" + "documentation": "The Unix timestamp when the Amazon Q Business application was last updated.
" }, "defaultEndpoint": { "shape": "Url", - "documentation": "The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully hosted by Amazon Web Services.
" + "documentation": "The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
" }, "status": { "shape": "WebExperienceStatus", - "documentation": "The status of your Amazon Q web experience.
" + "documentation": "The status of your Amazon Q Business web experience.
" }, "updatedAt": { "shape": "Timestamp", - "documentation": "The Unix timestamp when your Amazon Q web experience was updated.
" + "documentation": "The Unix timestamp when your Amazon Q Business web experience was updated.
" }, "webExperienceId": { "shape": "WebExperienceId", - "documentation": "The identifier of your Amazon Q web experience.
" + "documentation": "The identifier of your Amazon Q Business web experience.
" } }, - "documentation": "Provides information for an Amazon Q web experience.
" + "documentation": "Provides information for an Amazon Q Business web experience.
" }, "WebExperienceArn": { "type": "string", @@ -6944,7 +7048,7 @@ "shape": "SamlConfiguration" } }, - "documentation": "Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.
", + "documentation": "Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
", "union": true }, "WebExperienceId": { @@ -6994,5 +7098,5 @@ } } }, - "documentation": "Amazon Q is in preview release and is subject to change.
This is the Amazon Q (for business use) API Reference. Amazon Q is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q (for business use) Developer Guide .
For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q in the Amazon Q (for business use) Developer Guide.
You can use the following AWS SDKs to access Amazon Q APIs:
The following resources provide additional information about using the Amazon Q API:
" + "documentation": "Amazon Q is in preview release and is subject to change.
This is the Amazon Q Business API Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the Amazon Q Business User Guide .
For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business API operations.
For information about the IAM access control permissions you need to use this API, see IAM roles for Amazon Q Business in the Amazon Q Business User Guide.
You can use the following AWS SDKs to access Amazon Q Business APIs:
The following resources provide additional information about using the Amazon Q Business API:
>1,l=23===i?Math.pow(2,-24)-Math.pow(2,-77):0,d=a?0:s-1,y=a?1:-1,b=t<0||0===t&&1/t<0?1:0;for(t=Math.abs(t),isNaN(t)||t===1/0?(n=isNaN(t)?1:0,o=m):(o=Math.floor(Math.log(t)/Math.LN2),t*(u=Math.pow(2,-o))<1&&(o--,u*=2),t+=o+c>=1?l/u:l*Math.pow(2,1-c),t*u>=2&&(o++,u/=2),o+c>=m?(n=0,o=m):o+c>=1?(n=(t*u-1)*Math.pow(2,i),o+=c):(n=t*Math.pow(2,c-1)*Math.pow(2,i),o=0));i>=8;e[r+d]=255&n,d+=y,n/=256,i-=8);for(o=o<0;e[r+d]=255&o,d+=y,o/=256,p-=8);e[r+d-y]|=128*b}},{}],443:[function(e,t,r){var a={}.toString;t.exports=Array.isArray||function(e){return"[object Array]"==a.call(e)}},{}],444:[function(e,t,r){!function(e){"use strict";function t(e){return null!==e&&"[object Array]"===Object.prototype.toString.call(e)}function r(e){return null!==e&&"[object Object]"===Object.prototype.toString.call(e)}function a(e,i){if(e===i)return!0;if(Object.prototype.toString.call(e)!==Object.prototype.toString.call(i))return!1;if(!0===t(e)){if(e.length!==i.length)return!1;for(var s=0;s G((f-r)/g)&&i("overflow"),r+=(p-t)*g,t=p,u=0;u=55296&&t<=56319&&i65535&&(e-=65536,t+=w(e>>>10&1023|55296),e=56320|1023&e),t+=w(e)}).join("")}function p(e){return e-48<10?e-22:e-65<26?e-65:e-97<26?e-97:T}function m(e,t){return e+22+75*(e<26)-((0!=t)<<5)}function c(e,t,r){var a=0;for(e=r?G(e/R):e>>1,e+=G(e/t);e>L*k>>1;a+=T)e=G(e/L);return G(a+(L+1)*e/(e+A))}function l(e){var t,r,a,s,o,n,m,l,d,y,b=[],S=e.length,g=0,h=v,I=D;for(r=e.lastIndexOf(x),r<0&&(r=0),a=0;a=S&&i("invalid-input"),l=p(e.charCodeAt(s++)),(l>=T||l>G((f-g)/n))&&i("overflow"),g+=l*n,d=m<=I?C:m>=I+k?k:m-I,!(l=t&&bf&&i("overflow"),b==t){for(l=r,d=T;y=d<=o?C:d>=o+k?k:d-o,!(l=0&&delete e.httpRequest.headers["Content-Length"]}function i(e){var t=new l,r=e.service.api.operations[e.operation].input;if(r.payload){var a={},i=r.members[r.payload];a=e.params[r.payload],"structure"===i.type?(e.httpRequest.body=t.build(a||{},i),s(e)):void 0!==a&&(e.httpRequest.body=a,("binary"===i.type||i.isStreaming)&&s(e,!0))}else e.httpRequest.body=t.build(e.params,r),s(e)}function s(e,t){if(!e.httpRequest.headers["Content-Type"]){var r=t?"binary/octet-stream":"application/json";e.httpRequest.headers["Content-Type"]=r}}function o(e){m.buildRequest(e),y.indexOf(e.httpRequest.method)<0&&i(e)}function n(e){c.extractError(e)}function u(e){m.extractData(e);var t,r=e.request,a=r.service.api.operations[r.operation],i=r.service.api.operations[r.operation].output||{};a.hasEventOutput;if(i.payload){var s=i.members[i.payload],o=e.httpResponse.body;if(s.isEventStream)t=new d,e.data[payload]=p.createEventStream(2===AWS.HttpClient.streamsApiVersion?e.httpResponse.stream:o,t,s);else if("structure"===s.type||"list"===s.type){var t=new d;e.data[i.payload]=t.parse(o,s)}else"binary"===s.type||s.isStreaming?e.data[i.payload]=o:e.data[i.payload]=s.toType(o)}else{var n=e.data;c.extractData(e),e.data=p.merge(n,e.data)}}var p=e("../util"),m=e("./rest"),c=e("./json"),l=e("../json/builder"),d=e("../json/parser"),y=["GET","HEAD","DELETE"];t.exports={buildRequest:o,extractError:n,extractData:u,unsetContentLength:a}},{"../json/builder":374,"../json/parser":375,"../util":428,"./json":386,"./rest":388}],390:[function(e,t,r){function a(e){var t=e.service.api.operations[e.operation].input,r=new n.XML.Builder,a=e.params,i=t.payload;if(i){var s=t.members[i];if(void 0===(a=a[i]))return;if("structure"===s.type){var o=s.name;e.httpRequest.body=r.toXML(a,s,o,!0)}else e.httpRequest.body=a}else e.httpRequest.body=r.toXML(a,t,t.name||t.shape||u.string.upperFirst(e.operation)+"Request")}function i(e){p.buildRequest(e),["GET","HEAD"].indexOf(e.httpRequest.method)<0&&a(e)}function s(e){p.extractError(e);var t;try{t=(new n.XML.Parser).parse(e.httpResponse.body.toString())}catch(r){t={Code:e.httpResponse.statusCode,Message:e.httpResponse.statusMessage}}t.Errors&&(t=t.Errors),t.Error&&(t=t.Error),t.Code?e.error=u.error(new Error,{code:t.Code,message:t.Message}):e.error=u.error(new Error,{code:e.httpResponse.statusCode,message:null})}function o(e){p.extractData(e);var t,r=e.request,a=e.httpResponse.body,i=r.service.api.operations[r.operation],s=i.output,o=(i.hasEventOutput,s.payload);if(o){var m=s.members[o];m.isEventStream?(t=new n.XML.Parser,e.data[o]=u.createEventStream(2===n.HttpClient.streamsApiVersion?e.httpResponse.stream:e.httpResponse.body,t,m)):"structure"===m.type?(t=new n.XML.Parser,e.data[o]=t.parse(a.toString(),m)):"binary"===m.type||m.isStreaming?e.data[o]=a:e.data[o]=m.toType(a)}else if(a.length>0){t=new n.XML.Parser;var c=t.parse(a.toString(),s);u.update(e.data,c)}}var n=e("../core"),u=e("../util"),p=e("./rest");t.exports={buildRequest:i,extractError:s,extractData:o}},{"../core":350,"../util":428,"./rest":388}],391:[function(e,t,r){function a(){}function i(e){return e.isQueryName||"ec2"!==e.api.protocol?e.name:e.name[0].toUpperCase()+e.name.substr(1)}function s(e,t,r,a){p.each(r.members,function(r,s){var o=t[r];if(null!==o&&void 0!==o){var n=i(s);n=e?e+"."+n:n,u(n,o,s,a)}})}function o(e,t,r,a){var i=1;p.each(t,function(t,s){var o=r.flattened?".":".entry.",n=o+i+++".",p=n+(r.key.name||"key"),m=n+(r.value.name||"value");u(e+p,t,r.key,a),u(e+m,s,r.value,a)})}function n(e,t,r,a){var s=r.member||{};if(0===t.length)return void a.call(this,e,null);p.arrayEach(t,function(t,o){var n="."+(o+1);if("ec2"===r.api.protocol)n+="";else if(r.flattened){if(s.name){var p=e.split(".");p.pop(),p.push(i(s)),e=p.join(".")}}else n="."+(s.name?s.name:"member")+n;u(e+n,t,s,a)})}function u(e,t,r,a){null!==t&&void 0!==t&&("structure"===r.type?s(e,t,r,a):"list"===r.type?n(e,t,r,a):"map"===r.type?o(e,t,r,a):a(e,r.toWireFormat(t).toString()))}var p=e("../util");a.prototype.serialize=function(e,t,r){s("",e,t,r)},t.exports=a},{"../util":428}],392:[function(e,t,r){var a=e("../core"),i=null,s={signatureVersion:"v4",signingName:"rds-db",operations:{}},o={region:"string",hostname:"string",port:"number",username:"string"};a.RDS.Signer=a.util.inherit({constructor:function(e){this.options=e||{}},convertUrlToAuthToken:function(e){if(0===e.indexOf("https://"))return e.substring("https://".length)},getAuthToken:function(e,t){"function"==typeof e&&void 0===t&&(t=e,e={});var r=this,o="function"==typeof t;e=a.util.merge(this.options,e);var n=this.validateAuthTokenOptions(e);if(!0!==n){if(o)return t(n,null);throw n}var u={region:e.region,endpoint:new a.Endpoint(e.hostname+":"+e.port),paramValidation:!1,signatureVersion:"v4"};e.credentials&&(u.credentials=e.credentials),i=new a.Service(u),i.api=s;var p=i.makeRequest();if(this.modifyRequestForAuthToken(p,e),!o){var m=p.presign(900);return this.convertUrlToAuthToken(m)}p.presign(900,function(e,a){a&&(a=r.convertUrlToAuthToken(a)),t(e,a)})},modifyRequestForAuthToken:function(e,t){e.on("build",e.buildAsGet),e.httpRequest.body=a.util.queryParamsToString({Action:"connect",DBUser:t.username})},validateAuthTokenOptions:function(e){var t="";e=e||{};for(var r in o)Object.prototype.hasOwnProperty.call(o,r)&&typeof e[r]!==o[r]&&(t+="option '"+r+"' should have been type '"+o[r]+"', was '"+typeof e[r]+"'.\n");return!t.length||a.util.error(new Error,{code:"InvalidParameter",message:t})}})},{"../core":350}],393:[function(e,t,r){t.exports={now:function(){return"undefined"!=typeof performance&&"function"==typeof performance.now?performance.now():Date.now()}}},{}],394:[function(e,t,r){function a(e){return"string"==typeof e&&(e.startsWith("fips-")||e.endsWith("-fips"))}function i(e){return"string"==typeof e&&["aws-global","aws-us-gov-global"].includes(e)}function s(e){return["fips-aws-global","aws-fips","aws-global"].includes(e)?"us-east-1":["fips-aws-us-gov-global","aws-us-gov-global"].includes(e)?"us-gov-west-1":e.replace(/fips-(dkr-|prod-)?|-fips/,"")}t.exports={isFipsRegion:a,isGlobalRegion:i,getRealRegion:s}},{}],395:[function(e,t,r){function a(e){if(!e)return null;var t=e.split("-");return t.length<3?null:t.slice(0,t.length-2).join("-")+"-*"}function i(e){var t=e.config.region,r=a(t),i=e.api.endpointPrefix;return[[t,i],[r,i],[t,"*"],[r,"*"],["*",i],[t,"internal-*"],["*","*"]].map(function(e){return e[0]&&e[1]?e.join("/"):null})}function s(e,t){u.each(t,function(t,r){"globalEndpoint"!==t&&(void 0!==e.config[t]&&null!==e.config[t]||(e.config[t]=r))})}function o(e){for(var t=i(e),r=e.config.useFipsEndpoint,a=e.config.useDualstackEndpoint,o=0;o=a())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+a().toString(16)+" bytes");return 0|e}function b(e){return+e!=e&&(e=0),s.alloc(+e)}function S(e,t){if(s.isBuffer(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var r=e.length;if(0===r)return 0;for(var a=!1;;)switch(t){case"ascii":case"latin1":case"binary":return r;case"utf8":case"utf-8":case void 0:return K(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*r;case"hex":return r>>>1;case"base64":return H(e).length;default:if(a)return K(e).length;t=(""+t).toLowerCase(),a=!0}}function g(e,t,r){var a=!1;if((void 0===t||t<0)&&(t=0),t>this.length)return"";if((void 0===r||r>this.length)&&(r=this.length),r<=0)return"";if(r>>>=0,t>>>=0,r<=t)return"";for(e||(e="utf8");;)switch(e){case"hex":return E(this,t,r);case"utf8":case"utf-8":return v(this,t,r);case"ascii":return P(this,t,r);case"latin1":case"binary":return q(this,t,r);case"base64":return D(this,t,r);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return M(this,t,r);default:if(a)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),a=!0}}function h(e,t,r){var a=e[t];e[t]=e[r],e[r]=a}function I(e,t,r,a,i){if(0===e.length)return-1;if("string"==typeof r?(a=r,r=0):r>2147483647?r=2147483647:r<-2147483648&&(r=-2147483648),r=+r,isNaN(r)&&(r=i?0:e.length-1),r<0&&(r=e.length+r),r>=e.length){if(i)return-1;r=e.length-1}else if(r<0){if(!i)return-1;r=0}if("string"==typeof t&&(t=s.from(t,a)),s.isBuffer(t))return 0===t.length?-1:N(e,t,r,a,i);if("number"==typeof t)return t&=255,s.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?i?Uint8Array.prototype.indexOf.call(e,t,r):Uint8Array.prototype.lastIndexOf.call(e,t,r):N(e,[t],r,a,i);throw new TypeError("val must be string, number or Buffer")}function N(e,t,r,a,i){function s(e,t){return 1===o?e[t]:e.readUInt16BE(t*o)}var o=1,n=e.length,u=t.length;if(void 0!==a&&("ucs2"===(a=String(a).toLowerCase())||"ucs-2"===a||"utf16le"===a||"utf-16le"===a)){if(e.length<2||t.length<2)return-1;o=2,n/=2,u/=2,r/=2}var p;if(i){var m=-1;for(p=r;p>>8*(a?i:1-i)}function B(e,t,r,a){t<0&&(t=4294967295+t+1);for(var i=0,s=Math.min(e.length-r,4);i>>8*(a?i:3-i)&255}function U(e,t,r,a,i,s){if(r+a>e.length)throw new RangeError("Index out of range");if(r<0)throw new RangeError("Index out of range")}function _(e,t,r,a,i){return i||U(e,t,r,4,3.4028234663852886e38,-3.4028234663852886e38),X.write(e,t,r,a,23,4),r+4}function F(e,t,r,a,i){return i||U(e,t,r,8,1.7976931348623157e308,-1.7976931348623157e308),X.write(e,t,r,a,52,8),r+8}function O(e){if(e=V(e).replace(ee,""),e.length<2)return"";for(;e.length%4!=0;)e+="=";return e}function V(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}function z(e){return e<16?"0"+e.toString(16):e.toString(16)}function K(e,t){t=t||1/0;for(var r,a=e.length,i=null,s=[],o=0;o55295&&r<57344){if(!i){if(r>56319){(t-=3)>-1&&s.push(239,191,189);continue}if(o+1===a){(t-=3)>-1&&s.push(239,191,189);continue}i=r;continue}if(r<56320){(t-=3)>-1&&s.push(239,191,189),i=r;continue}r=65536+(i-55296<<10|r-56320)}else i&&(t-=3)>-1&&s.push(239,191,189);if(i=null,r<128){if((t-=1)<0)break;s.push(r)}else if(r<2048){if((t-=2)<0)break;s.push(r>>6|192,63&r|128)}else if(r<65536){if((t-=3)<0)break;s.push(r>>12|224,r>>6&63|128,63&r|128)}else{if(!(r<1114112))throw new Error("Invalid code point");if((t-=4)<0)break;s.push(r>>18|240,r>>12&63|128,r>>6&63|128,63&r|128)}}return s}function j(e){for(var t=[],r=0;r