Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
", "CancelImportTask": "Cancels an in-process import virtual machine or import snapshot task.
", "CancelReservedInstancesListing": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
", - "CancelSpotFleetRequests": "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.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.
", "CopyFpgaImage": "Copies the specified Amazon FPGA Image (AFI) to the current Region.
", @@ -147,7 +147,7 @@ "DeleteCustomerGateway": "Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
", "DeleteDhcpOptions": "Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.
", "DeleteEgressOnlyInternetGateway": "Deletes an egress-only internet gateway.
", - "DeleteFleets": "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.
", + "DeleteFleets": "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": "Deletes one or more flow logs.
", "DeleteFpgaImage": "Deletes the specified Amazon FPGA Image (AFI).
", "DeleteInstanceConnectEndpoint": "Deletes the specified EC2 Instance Connect Endpoint.
", @@ -273,8 +273,8 @@ "DescribeInstanceEventWindows": "Describes the specified event windows or all event windows.
If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", "DescribeInstanceStatus": "Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the Amazon Web Services network to support your tightly coupled workloads.
Limitations
Supported zones
Availability Zone
Local Zone
Supported instance types
hpc6a.48xlarge | hpc6id.32xlarge | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge
p3dn.24xlarge | p4d.24xlarge | p4de.24xlarge | p5.48xlarge
trn1.2xlarge | trn1.32xlarge | trn1n.32xlarge
For more information, see Amazon EC2 instance topology in the Amazon EC2 User Guide.
", - "DescribeInstanceTypeOfferings": "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.
", - "DescribeInstanceTypes": "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.
", + "DescribeInstanceTypeOfferings": "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": "Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results.
", "DescribeInstances": "Describes the specified instances or all instances.
If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.
If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.
The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
Describes one or more of your internet gateways.
", "DescribeIpamByoasn": "Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.
", @@ -434,7 +434,7 @@ "GetCapacityReservationUsage": "Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
", "GetCoipPoolUsage": "Describes the allocations from the specified customer-owned address pool.
", "GetConsoleOutput": "Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
", - "GetConsoleScreenshot": "Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
", + "GetConsoleScreenshot": "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": "Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
", "GetEbsDefaultKmsKeyId": "Describes the default KMS key for EBS encryption by default for your account in this Region. You can change the default KMS key for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", "GetEbsEncryptionByDefault": "Describes whether EBS encryption by default is enabled for your account in the current Region.
For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
", @@ -504,7 +504,7 @@ "ModifyInstanceEventStartTime": "Modifies the start time for a scheduled Amazon EC2 instance event.
", "ModifyInstanceEventWindow": "Modifies the specified event window.
You can define either a set of time ranges or a cron expression when modifying the event window, but not both.
To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.
If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
", "ModifyInstanceMaintenanceOptions": "Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see Simplified automatic recovery.
", - "ModifyInstanceMetadataDefaults": "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.
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
", "ModifyInstancePlacement": "Modifies the placement attributes for a specified instance. You can do the following:
Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.
Change the Dedicated Host with which an instance is associated.
Change the instance tenancy of an instance.
Move an instance to or from a placement group.
At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.
To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.
Modify the configurations of an IPAM.
", @@ -2935,7 +2935,7 @@ "base": null, "refs": { "InstanceMetadataDefaultsResponse$HttpPutResponseHopLimit": "The maximum number of hops that the metadata token can travel.
", - "ModifyInstanceMetadataDefaultsRequest$HttpPutResponseHopLimit": "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
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.
One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The filters.
availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the instance is in.
instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.
zone-id - The ID of the Availability Zone (for example, usw2-az2) or Local Zone (for example, usw2-lax1-az1) that the instance is in.
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.
One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, \"25 Gigabit\").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, \"1\" or \"1,2\".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
boot-mode - The boot mode that was specified by the AMI (legacy-bios | uefi | uefi-preferred).
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity Reservation preference (open | none).
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.
capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.
client-token - The idempotency token you provided when you launched the instance.
current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (legacy-bios | uefi).
dns-name - The public DNS name of the instance.
ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.
enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
iam-instance-profile.name - The instance profile associated with the instance. Specified as an name.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (spot | scheduled | capacity-block).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
ipv6-address - The IPv6 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (disabled | default).
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (disabled | enabled).
metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (disabled | enabled).
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
metadata-options.state - The state of the metadata option changes (pending | applied).
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.association.allocation-id - The allocation ID.
network-interface.addresses.association.association-id - The association ID.
network-interface.addresses.association.carrier-ip - The carrier IP address.
network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.addresses.association.public-dns-name - The public DNS name.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.private-dns-name - The private DNS name.
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.association.carrier-ip - The customer-owned IP address.
network-interface.association.customer-owned-ip - The customer-owned IP address.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.public-dns-name - The public DNS name.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.network-card-index - The index of the network card.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.
network-interface.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.
network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.
network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.outpost-arn - The ARN of the Outpost.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.private-ip-address - The private IPv4 address.
network-interface.public-dns-name - The public DNS name.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.tag-key - The key of a tag assigned to the network interface.
network-interface.tag-value - The value of a tag assigned to the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).
private-dns-name - The private IPv4 DNS name of the instance.
private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
private-dns-name-options.hostname-type - The type of hostname (ip-name | resource-name).
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
usage-operation - The usage operation value for the instance (RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The IDs of the EC2 Fleets.
", + "DeleteFleetsRequest$FleetIds": "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 IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The IDs of the security groups.
", "NetworkInterface$Groups": "Any security groups for the network interface.
", "Reservation$Groups": "Not supported.
", - "SpotFleetLaunchSpecification$SecurityGroups": "The security groups.
" + "SpotFleetLaunchSpecification$SecurityGroups": "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.
" } }, "GroupIdentifierSet": { @@ -11788,8 +11788,8 @@ "refs": { "LaunchSpecification$NetworkInterfaces": "The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
", "RequestSpotLaunchSpecification$NetworkInterfaces": "The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
", - "RunInstancesRequest$NetworkInterfaces": "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.
", - "SpotFleetLaunchSpecification$NetworkInterfaces": "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 to associate with the instance.
", + "SpotFleetLaunchSpecification$NetworkInterfaces": "The network interfaces.
SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
" + "DescribeInstanceTypesResult$InstanceTypes": "The instance type.
" } }, "InstanceTypeList": { @@ -12027,7 +12027,7 @@ "InstanceTypeOfferingsList": { "base": null, "refs": { - "DescribeInstanceTypeOfferingsResult$InstanceTypeOfferings": "The instance types offered.
" + "DescribeInstanceTypeOfferingsResult$InstanceTypeOfferings": "The instance types offered in the location.
" } }, "InstanceTypes": { @@ -13742,7 +13742,7 @@ "LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList": { "base": null, "refs": { - "RequestLaunchTemplateData$NetworkInterfaces": "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.
" + "RequestLaunchTemplateData$NetworkInterfaces": "The network interfaces for the instance.
" } }, "LaunchTemplateLicenseConfiguration": { @@ -14263,7 +14263,7 @@ "LocationType": { "base": null, "refs": { - "DescribeInstanceTypeOfferingsRequest$LocationType": "The location type.
", + "DescribeInstanceTypeOfferingsRequest$LocationType": "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.
The location type.
" } }, @@ -17524,7 +17524,7 @@ "RequestInstanceTypeList": { "base": null, "refs": { - "DescribeInstanceTypesRequest$InstanceTypes": "The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
" + "DescribeInstanceTypesRequest$InstanceTypes": "The instance types.
" } }, "RequestIpamResourceTag": { @@ -18520,8 +18520,8 @@ "InstanceNetworkInterfaceSpecification$Groups": "The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
", "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest$Groups": "The IDs of one or more security groups.
", "ModifyNetworkInterfaceAttributeRequest$Groups": "Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
", - "RequestLaunchTemplateData$SecurityGroupIds": "One or more security group IDs. You can create a security group using CreateSecurityGroup.
", - "RunInstancesRequest$SecurityGroupIds": "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.
" + "RequestLaunchTemplateData$SecurityGroupIds": "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.
", + "RunInstancesRequest$SecurityGroupIds": "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.
" } }, "SecurityGroupIdStringListRequest": { @@ -18641,8 +18641,8 @@ "base": null, "refs": { "ImportInstanceLaunchSpecification$GroupNames": "The security group names.
", - "RequestLaunchTemplateData$SecurityGroups": "One or more security group names. For a nondefault VPC, you must use security group IDs instead.
", - "RunInstancesRequest$SecurityGroups": "[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.
" + "RequestLaunchTemplateData$SecurityGroups": "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.
", + "RunInstancesRequest$SecurityGroups": "[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.
" } }, "SelfServicePortal": { @@ -18945,7 +18945,7 @@ "SpotFleetRequestIdList": { "base": null, "refs": { - "CancelSpotFleetRequestsRequest$SpotFleetRequestIds": "The IDs of the Spot Fleet requests.
", + "CancelSpotFleetRequestsRequest$SpotFleetRequestIds": "The IDs of the Spot Fleet requests.
Constraint: You can specify up to 100 IDs in a single request.
", "DescribeSpotFleetRequestsRequest$SpotFleetRequestIds": "The IDs of the Spot Fleet requests.
" } }, @@ -19558,8 +19558,8 @@ "CreateCustomerGatewayRequest$IpAddress": "IPv4 address for the customer gateway device's outside interface. The address must be static.
", "CreateEgressOnlyInternetGatewayRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateEgressOnlyInternetGatewayResult$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", - "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", - "CreateFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", + "CreateFleetError$ErrorCode": "The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
", + "CreateFleetError$ErrorMessage": "The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
", "CreateFleetRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
", "CreateFleetRequest$Context": "Reserved.
", "CreateFlowLogsRequest$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
", @@ -21501,10 +21501,10 @@ "ModifySubnetAttributeRequest$SubnetId": "The ID of the subnet.
", "ModifyVerifiedAccessEndpointSubnetIdList$member": null, "RequestSpotLaunchSpecification$SubnetId": "The ID of the subnet in which to launch the instance.
", - "RunInstancesRequest$SubnetId": "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.
", + "RunInstancesRequest$SubnetId": "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.
", "ScheduledInstancesLaunchSpecification$SubnetId": "The ID of the subnet in which to launch the instances.
", "ScheduledInstancesNetworkInterface$SubnetId": "The ID of the subnet.
", - "SpotFleetLaunchSpecification$SubnetId": "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\".
", + "SpotFleetLaunchSpecification$SubnetId": "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.
", "SubnetCidrReservation$SubnetId": "The ID of the subnet.
", "SubnetConfiguration$SubnetId": "The ID of the subnet.
", "SubnetIdStringList$member": null, @@ -22533,7 +22533,7 @@ "GetTransitGatewayRouteTableAssociationsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
The maximum number of routes to return.
" + "SearchTransitGatewayRoutesRequest$MaxResults": "The maximum number of routes to return. If a value is not provided, the default is 1000.
" } }, "TransitGatewayMulitcastDomainAssociationState": { diff --git a/models/apis/ec2/2016-11-15/smoke-2.json b/models/apis/ec2/2016-11-15/smoke-2.json new file mode 100644 index 00000000000..5134f45f57f --- /dev/null +++ b/models/apis/ec2/2016-11-15/smoke-2.json @@ -0,0 +1,31 @@ +{ + "version": 2, + "testCases": [ + { + "id": "DescribeRegionsSuccess", + "operationName": "DescribeRegions", + "input": {}, + "expectation": { + "success": {} + }, + "config": { + "region": "us-west-2" + } + }, + { + "id": "DescribeInstancesFailure", + "operationName": "DescribeInstances", + "input": { + "InstanceIds": [ + "i-12345678" + ] + }, + "expectation": { + "failure": {} + }, + "config": { + "region": "us-west-2" + } + } + ] +} diff --git a/models/apis/qbusiness/2023-11-27/api-2.json b/models/apis/qbusiness/2023-11-27/api-2.json index 632af1409a3..94be3158afb 100644 --- a/models/apis/qbusiness/2023-11-27/api-2.json +++ b/models/apis/qbusiness/2023-11-27/api-2.json @@ -2040,6 +2040,17 @@ }, "type": "structure" }, + "AppliedCreatorModeConfiguration": { + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl" + } + }, + "required": [ + "creatorModeControl" + ], + "type": "structure" + }, "AttachmentInput": { "members": { "data": { @@ -2307,6 +2318,23 @@ "min": 0, "type": "long" }, + "ChatMode": { + "enum": [ + "RETRIEVAL_MODE", + "CREATOR_MODE", + "PLUGIN_MODE" + ], + "type": "string" + }, + "ChatModeConfiguration": { + "members": { + "pluginConfiguration": { + "shape": "PluginConfiguration" + } + }, + "type": "structure", + "union": true + }, "ChatSyncInput": { "members": { "applicationId": { @@ -2320,6 +2348,12 @@ "attributeFilter": { "shape": "AttributeFilter" }, + "chatMode": { + "shape": "ChatMode" + }, + "chatModeConfiguration": { + "shape": "ChatModeConfiguration" + }, "clientToken": { "idempotencyToken": true, "shape": "ClientToken" @@ -2345,8 +2379,7 @@ } }, "required": [ - "applicationId", - "userId" + "applicationId" ], "type": "structure" }, @@ -2485,6 +2518,9 @@ "encryptionConfiguration": { "shape": "EncryptionConfiguration" }, + "identityCenterInstanceArn": { + "shape": "InstanceArn" + }, "roleArn": { "shape": "RoleArn" }, @@ -2701,6 +2737,9 @@ "idempotencyToken": true, "shape": "ClientToken" }, + "roleArn": { + "shape": "RoleArn" + }, "samplePromptsControlMode": { "shape": "WebExperienceSamplePromptsControlMode" }, @@ -2733,6 +2772,24 @@ }, "type": "structure" }, + "CreatorModeConfiguration": { + "members": { + "creatorModeControl": { + "shape": "CreatorModeControl" + } + }, + "required": [ + "creatorModeControl" + ], + "type": "structure" + }, + "CreatorModeControl": { + "enum": [ + "ENABLED", + "DISABLED" + ], + "type": "string" + }, "DataSource": { "members": { "createdAt": { @@ -2952,8 +3009,7 @@ }, "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "type": "structure" }, @@ -3577,6 +3633,9 @@ "error": { "shape": "ErrorDetail" }, + "identityCenterApplicationArn": { + "shape": "IdcApplicationArn" + }, "roleArn": { "shape": "RoleArn" }, @@ -3617,6 +3676,9 @@ "blockedPhrases": { "shape": "BlockedPhrasesConfiguration" }, + "creatorModeConfiguration": { + "shape": "AppliedCreatorModeConfiguration" + }, "nextToken": { "shape": "NextToken" }, @@ -3976,6 +4038,9 @@ "error": { "shape": "ErrorDetail" }, + "roleArn": { + "shape": "RoleArn" + }, "samplePromptsControlMode": { "shape": "WebExperienceSamplePromptsControlMode" }, @@ -4081,6 +4146,12 @@ }, "type": "structure" }, + "IdcApplicationArn": { + "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}$", + "type": "string" + }, "Index": { "members": { "createdAt": { @@ -4188,6 +4259,12 @@ "min": 1, "type": "list" }, + "InstanceArn": { + "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}$", + "type": "string" + }, "Integer": { "box": true, "type": "integer" @@ -4303,8 +4380,7 @@ } }, "required": [ - "applicationId", - "userId" + "applicationId" ], "type": "structure" }, @@ -4580,8 +4656,7 @@ }, "required": [ "applicationId", - "conversationId", - "userId" + "conversationId" ], "type": "structure" }, @@ -5058,6 +5133,17 @@ "type": "structure", "union": true }, + "PluginConfiguration": { + "members": { + "pluginId": { + "shape": "PluginId" + } + }, + "required": [ + "pluginId" + ], + "type": "structure" + }, "PluginId": { "max": 36, "min": 36, @@ -5176,8 +5262,7 @@ "required": [ "applicationId", "conversationId", - "messageId", - "userId" + "messageId" ], "type": "structure" }, @@ -5883,6 +5968,9 @@ "idempotencyToken": true, "shape": "ClientToken" }, + "creatorModeConfiguration": { + "shape": "CreatorModeConfiguration" + }, "responseScope": { "shape": "ResponseScope" }, diff --git a/models/apis/qbusiness/2023-11-27/docs-2.json b/models/apis/qbusiness/2023-11-27/docs-2.json index d37a72f5215..bc325356181 100644 --- a/models/apis/qbusiness/2023-11-27/docs-2.json +++ b/models/apis/qbusiness/2023-11-27/docs-2.json @@ -1,62 +1,62 @@ { "version": "2.0", - "service": "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:
", + "service": "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:
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.
", - "BatchPutDocument": "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.
", - "ChatSync": "Starts or continues a non-streaming Amazon Q conversation.
", - "CreateApplication": "Creates an Amazon Q application.
", - "CreateDataSource": "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 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 plugin.
", - "CreateRetriever": "Adds a retriever to your Amazon Q application.
", + "BatchDeleteDocument": "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": "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": "Starts or continues a non-streaming Amazon Q Business conversation.
", + "CreateApplication": "Creates an Amazon Q Business application.
", + "CreateDataSource": "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 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 Business plugin.
", + "CreateRetriever": "Adds a retriever to your Amazon Q Business application.
", "CreateUser": "Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.
", - "CreateWebExperience": "Creates an Amazon Q web experience.
", - "DeleteApplication": "Deletes an Amazon Q application.
", - "DeleteChatControlsConfiguration": "Deletes chat controls configured for an existing Amazon Q application.
", - "DeleteConversation": "Deletes an Amazon Q web experience conversation.
", - "DeleteDataSource": "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.
Creates an Amazon Q Business web experience.
", + "DeleteApplication": "Deletes an Amazon Q Business application.
", + "DeleteChatControlsConfiguration": "Deletes chat controls configured for an existing Amazon Q Business application.
", + "DeleteConversation": "Deletes an Amazon Q Business web experience conversation.
", + "DeleteDataSource": "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 a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group \"Summer Interns\", all interns who belonged to that group no longer see intern-only documents in their chat results.
If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group \"Engineering\" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the \"Engineering\" group when calling PutGroup.
Deletes an Amazon Q index.
", - "DeletePlugin": "Deletes an Amazon Q plugin.
", - "DeleteRetriever": "Deletes the retriever used by an Amazon Q application.
", + "DeleteIndex": "Deletes an Amazon Q Business index.
", + "DeletePlugin": "Deletes an Amazon Q Business plugin.
", + "DeleteRetriever": "Deletes the retriever used by an Amazon Q Business application.
", "DeleteUser": "Deletes a user by email id.
", - "DeleteWebExperience": "Deletes an Amazon Q web experience.
", - "GetApplication": "Gets information about an existing Amazon Q application.
", - "GetChatControlsConfiguration": "Gets information about an chat controls configured for an existing Amazon Q application.
", - "GetDataSource": "Gets information about an existing Amazon Q data source connector.
", + "DeleteWebExperience": "Deletes an Amazon Q Business web experience.
", + "GetApplication": "Gets information about an existing Amazon Q Business application.
", + "GetChatControlsConfiguration": "Gets information about an chat controls configured for an existing Amazon Q Business application.
", + "GetDataSource": "Gets information about an existing Amazon Q Business data source connector.
", "GetGroup": "Describes a group by group name.
", - "GetIndex": "Gets information about an existing Amazon Q index.
", - "GetPlugin": "Gets information about an existing Amazon Q plugin.
", - "GetRetriever": "Gets information about an existing retriever used by an Amazon Q application.
", + "GetIndex": "Gets information about an existing Amazon Q Business index.
", + "GetPlugin": "Gets information about an existing Amazon Q Business plugin.
", + "GetRetriever": "Gets information about an existing retriever used by an Amazon Q Business application.
", "GetUser": "Describes the universally unique identifier (UUID) associated with a local user in a data source.
", - "GetWebExperience": "Gets information about an existing Amazon Q web experience.
", - "ListApplications": "Lists Amazon Q applications.
", - "ListConversations": "Lists one or more Amazon Q conversations.
", - "ListDataSourceSyncJobs": "Get information about an Amazon Q data source connector synchronization.
", - "ListDataSources": "Lists the Amazon Q data source connectors that you have created.
", + "GetWebExperience": "Gets information about an existing Amazon Q Business web experience.
", + "ListApplications": "Lists Amazon Q Business applications.
", + "ListConversations": "Lists one or more Amazon Q Business conversations.
", + "ListDataSourceSyncJobs": "Get information about an Amazon Q Business data source connector synchronization.
", + "ListDataSources": "Lists the Amazon Q Business data source connectors that you have created.
", "ListDocuments": "A list of documents attached to an index.
", "ListGroups": "Provides a list of groups that are mapped to users.
", - "ListIndices": "Lists the Amazon Q indices you have created.
", - "ListMessages": "Gets a list of messages associated with an Amazon Q web experience.
", - "ListPlugins": "Lists configured Amazon Q plugins.
", - "ListRetrievers": "Lists the retriever used by an Amazon Q application.
", - "ListTagsForResource": "Gets a list of tags associated with a specified resource. Amazon Q applications and data sources can have tags associated with them.
", - "ListWebExperiences": "Lists one or more Amazon Q Web Experiences.
", - "PutFeedback": "Enables your end user to to provide feedback on their Amazon Q generated chat responses.
", - "PutGroup": "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.
", - "StartDataSourceSyncJob": "Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q returns a ConflictException.
Stops an Amazon Q data source connector synchronization job already in progress.
", - "TagResource": "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.
", - "UntagResource": "Removes a tag from an Amazon Q application or a data source.
", - "UpdateApplication": "Updates an existing Amazon Q application.
", - "UpdateChatControlsConfiguration": "Updates an set of chat controls configured for an existing Amazon Q application.
", - "UpdateDataSource": "Updates an existing Amazon Q data source connector.
", - "UpdateIndex": "Updates an Amazon Q index.
", - "UpdatePlugin": "Updates an Amazon Q plugin.
", - "UpdateRetriever": "Updates the retriever used for your Amazon Q application.
", + "ListIndices": "Lists the Amazon Q Business indices you have created.
", + "ListMessages": "Gets a list of messages associated with an Amazon Q Business web experience.
", + "ListPlugins": "Lists configured Amazon Q Business plugins.
", + "ListRetrievers": "Lists the retriever used by an Amazon Q Business application.
", + "ListTagsForResource": "Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.
", + "ListWebExperiences": "Lists one or more Amazon Q Business Web Experiences.
", + "PutFeedback": "Enables your end user to provide feedback on their Amazon Q Business generated chat responses.
", + "PutGroup": "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.
", + "StartDataSourceSyncJob": "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 Business data source connector synchronization job already in progress.
", + "TagResource": "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.
", + "UntagResource": "Removes a tag from an Amazon Q Business application or a data source.
", + "UpdateApplication": "Updates an existing Amazon Q Business application.
", + "UpdateChatControlsConfiguration": "Updates an set of chat controls configured for an existing Amazon Q Business application.
", + "UpdateDataSource": "Updates an existing Amazon Q Business data source connector.
", + "UpdateIndex": "Updates an Amazon Q Business index.
", + "UpdatePlugin": "Updates an Amazon Q Business plugin.
", + "UpdateRetriever": "Updates the retriever used for your Amazon Q Business application.
", "UpdateUser": "Updates a information associated with a user id.
", - "UpdateWebExperience": "Updates an Amazon Q web experience.
" + "UpdateWebExperience": "Updates an Amazon Q Business web experience.
" }, "shapes": { "AccessConfiguration": { @@ -83,16 +83,16 @@ } }, "ActionExecution": { - "base": "Performs an Amazon Q plugin action during a non-streaming chat conversation.
", + "base": "Performs an Amazon Q Business plugin action during a non-streaming chat conversation.
", "refs": { - "ChatSyncInput$actionExecution": "A request from an end user to perform an Amazon Q plugin action.
", + "ChatSyncInput$actionExecution": "A request from an end user to perform an Amazon Q Business plugin action.
", "Message$actionExecution": null } }, "ActionExecutionPayload": { "base": null, "refs": { - "ActionExecution$payload": "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.
" + "ActionExecution$payload": "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.
" } }, "ActionExecutionPayloadField": { @@ -131,16 +131,16 @@ } }, "ActionReview": { - "base": "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.
", + "base": "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.
", "refs": { - "ChatSyncOutput$actionReview": "A request from Amazon Q to the end user for information Amazon Q needs to successfully complete a requested plugin action.
", + "ChatSyncOutput$actionReview": "A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.
", "Message$actionReview": null } }, "ActionReviewPayload": { "base": null, "refs": { - "ActionReview$payload": "Field values that an end user needs to provide to Amazon Q for Amazon Q to perform the requested plugin action.
" + "ActionReview$payload": "Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
" } }, "ActionReviewPayloadField": { @@ -150,7 +150,7 @@ } }, "ActionReviewPayloadFieldAllowedValue": { - "base": "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.
", + "base": "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.
", "refs": { "ActionReviewPayloadFieldAllowedValues$member": null } @@ -158,19 +158,19 @@ "ActionReviewPayloadFieldAllowedValues": { "base": null, "refs": { - "ActionReviewPayloadField$allowedValues": "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.
" + "ActionReviewPayloadField$allowedValues": "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.
" } }, "AmazonResourceName": { "base": null, "refs": { - "ListTagsForResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to get a list of tags for.
", - "TagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application or data source to tag.
", - "UntagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q application, or data source to remove the tag from.
" + "ListTagsForResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.
", + "TagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.
", + "UntagResourceRequest$resourceARN": "The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.
" } }, "Application": { - "base": "Summary information for an Amazon Q application.
", + "base": "Summary information for an Amazon Q Business application.
", "refs": { "Applications$member": null } @@ -178,95 +178,95 @@ "ApplicationArn": { "base": null, "refs": { - "CreateApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q application.
", - "GetApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q application.
" + "CreateApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
", + "GetApplicationResponse$applicationArn": "The Amazon Resource Name (ARN) of the Amazon Q Business application.
" } }, "ApplicationId": { "base": null, "refs": { - "Application$applicationId": "The identifier for the Amazon Q application.
", - "BatchDeleteDocumentRequest$applicationId": "The identifier of the Amazon Q application.
", - "BatchPutDocumentRequest$applicationId": "The identifier of the Amazon Q application.
", - "ChatSyncInput$applicationId": "The identifier of the Amazon Q application linked to the Amazon Q conversation.
", - "CreateApplicationResponse$applicationId": "The identifier of the Amazon Q application.
", - "CreateDataSourceRequest$applicationId": "The identifier of the Amazon Q application the data source will be attached to.
", - "CreateIndexRequest$applicationId": "The identifier of the Amazon Q application using the index.
", + "Application$applicationId": "The identifier for the Amazon Q Business application.
", + "BatchDeleteDocumentRequest$applicationId": "The identifier of the Amazon Q Business application.
", + "BatchPutDocumentRequest$applicationId": "The identifier of the Amazon Q Business application.
", + "ChatSyncInput$applicationId": "The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
", + "CreateApplicationResponse$applicationId": "The identifier of the Amazon Q Business application.
", + "CreateDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application the data source will be attached to.
", + "CreateIndexRequest$applicationId": "The identifier of the Amazon Q Business application using the index.
", "CreatePluginRequest$applicationId": "The identifier of the application that will contain the plugin.
", - "CreateRetrieverRequest$applicationId": "The identifier of your Amazon Q application.
", + "CreateRetrieverRequest$applicationId": "The identifier of your Amazon Q Business application.
", "CreateUserRequest$applicationId": "The identifier of the application for which the user mapping will be created.
", - "CreateWebExperienceRequest$applicationId": "The identifier of the Amazon Q web experience.
", - "DeleteApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", + "CreateWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business web experience.
", + "DeleteApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", "DeleteChatControlsConfigurationRequest$applicationId": "The identifier of the application the chat controls have been configured for.
", - "DeleteConversationRequest$applicationId": "The identifier of the Amazon Q application associated with the conversation.
", - "DeleteDataSourceRequest$applicationId": "The identifier of the Amazon Q application used with the data source connector.
", + "DeleteConversationRequest$applicationId": "The identifier of the Amazon Q Business application associated with the conversation.
", + "DeleteDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application used with the data source connector.
", "DeleteGroupRequest$applicationId": "The identifier of the application in which the group mapping belongs.
", - "DeleteIndexRequest$applicationId": "The identifier of the Amazon Q application the Amazon Q index is linked to.
", - "DeletePluginRequest$applicationId": "The identifier the application attached to the Amazon Q plugin.
", - "DeleteRetrieverRequest$applicationId": "The identifier of the Amazon Q application using the retriever.
", + "DeleteIndexRequest$applicationId": "The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.
", + "DeletePluginRequest$applicationId": "The identifier the application attached to the Amazon Q Business plugin.
", + "DeleteRetrieverRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "DeleteUserRequest$applicationId": "The identifier of the application from which the user is being deleted.
", - "DeleteWebExperienceRequest$applicationId": "The identifier of the Amazon Q application linked to the Amazon Q web experience.
", - "GetApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", - "GetApplicationResponse$applicationId": "The identifier of the Amazon Q application.
", + "DeleteWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.
", + "GetApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", + "GetApplicationResponse$applicationId": "The identifier of the Amazon Q Business application.
", "GetChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", - "GetDataSourceRequest$applicationId": "The identifier of the Amazon Q application.
", - "GetDataSourceResponse$applicationId": "The identifier of the Amazon Q application.
", + "GetDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application.
", + "GetDataSourceResponse$applicationId": "The identifier of the Amazon Q Business application.
", "GetGroupRequest$applicationId": "The identifier of the application id the group is attached to.
", - "GetIndexRequest$applicationId": "The identifier of the Amazon Q application connected to the index.
", - "GetIndexResponse$applicationId": "The identifier of the Amazon Q application associated with the index.
", + "GetIndexRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", + "GetIndexResponse$applicationId": "The identifier of the Amazon Q Business application associated with the index.
", "GetPluginRequest$applicationId": "The identifier of the application which contains the plugin.
", "GetPluginResponse$applicationId": "The identifier of the application which contains the plugin.
", - "GetRetrieverRequest$applicationId": "The identifier of the Amazon Q application using the retriever.
", - "GetRetrieverResponse$applicationId": "The identifier of the Amazon Q application using the retriever.
", + "GetRetrieverRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", + "GetRetrieverResponse$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", "GetUserRequest$applicationId": "The identifier of the application connected to the user.
", - "GetWebExperienceRequest$applicationId": "The identifier of the Amazon Q application linked to the web experience.
", - "GetWebExperienceResponse$applicationId": "The identifier of the Amazon Q application linked to the web experience.
", - "ListConversationsRequest$applicationId": "The identifier of the Amazon Q application.
", - "ListDataSourceSyncJobsRequest$applicationId": "The identifier of the Amazon Q application connected to the data source.
", - "ListDataSourcesRequest$applicationId": "The identifier of the Amazon Q application linked to the data source connectors.
", + "GetWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application linked to the web experience.
", + "GetWebExperienceResponse$applicationId": "The identifier of the Amazon Q Business application linked to the web experience.
", + "ListConversationsRequest$applicationId": "The identifier of the Amazon Q Business application.
", + "ListDataSourceSyncJobsRequest$applicationId": "The identifier of the Amazon Q Business application connected to the data source.
", + "ListDataSourcesRequest$applicationId": "The identifier of the Amazon Q Business application linked to the data source connectors.
", "ListDocumentsRequest$applicationId": "The identifier of the application id the documents are attached to.
", "ListGroupsRequest$applicationId": "The identifier of the application for getting a list of groups mapped to users.
", - "ListIndicesRequest$applicationId": "The identifier of the Amazon Q application connected to the index.
", - "ListMessagesRequest$applicationId": "The identifier for the Amazon Q application.
", + "ListIndicesRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", + "ListMessagesRequest$applicationId": "The identifier for the Amazon Q Business application.
", "ListPluginsRequest$applicationId": "The identifier of the application the plugin is attached to.
", - "ListRetrieversRequest$applicationId": "The identifier of the Amazon Q application using the retriever.
", - "ListWebExperiencesRequest$applicationId": "The identifier of the Amazon Q application linked to the listed web experiences.
", + "ListRetrieversRequest$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", + "ListWebExperiencesRequest$applicationId": "The identifier of the Amazon Q Business application linked to the listed web experiences.
", "PutFeedbackRequest$applicationId": "The identifier of the application associated with the feedback.
", "PutGroupRequest$applicationId": "The identifier of the application in which the user and group mapping belongs.
", - "Retriever$applicationId": "The identifier of the Amazon Q application using the retriever.
", - "StartDataSourceSyncJobRequest$applicationId": "The identifier of Amazon Q application the data source is connected to.
", - "StopDataSourceSyncJobRequest$applicationId": "The identifier of the Amazon Q application that the data source is connected to.
", - "UpdateApplicationRequest$applicationId": "The identifier of the Amazon Q application.
", + "Retriever$applicationId": "The identifier of the Amazon Q Business application using the retriever.
", + "StartDataSourceSyncJobRequest$applicationId": "The identifier of Amazon Q Business application the data source is connected to.
", + "StopDataSourceSyncJobRequest$applicationId": "The identifier of the Amazon Q Business application that the data source is connected to.
", + "UpdateApplicationRequest$applicationId": "The identifier of the Amazon Q Business application.
", "UpdateChatControlsConfigurationRequest$applicationId": "The identifier of the application for which the chat controls are configured.
", - "UpdateDataSourceRequest$applicationId": "The identifier of the Amazon Q application the data source is attached to.
", - "UpdateIndexRequest$applicationId": "The identifier of the Amazon Q application connected to the index.
", + "UpdateDataSourceRequest$applicationId": "The identifier of the Amazon Q Business application the data source is attached to.
", + "UpdateIndexRequest$applicationId": "The identifier of the Amazon Q Business application connected to the index.
", "UpdatePluginRequest$applicationId": "The identifier of the application the plugin is attached to.
", - "UpdateRetrieverRequest$applicationId": "The identifier of your Amazon Q application.
", + "UpdateRetrieverRequest$applicationId": "The identifier of your Amazon Q Business application.
", "UpdateUserRequest$applicationId": "The identifier of the application the user is attached to.
", - "UpdateWebExperienceRequest$applicationId": "The identifier of the Amazon Q application attached to the web experience.
" + "UpdateWebExperienceRequest$applicationId": "The identifier of the Amazon Q Business application attached to the web experience.
" } }, "ApplicationName": { "base": null, "refs": { - "Application$displayName": "The name of the Amazon Q application.
", - "CreateApplicationRequest$displayName": "A name for the Amazon Q application.
", - "GetApplicationResponse$displayName": "The name of the Amazon Q application.
", - "UpdateApplicationRequest$displayName": "A name for the Amazon Q application.
", - "UpdateIndexRequest$displayName": "The name of the Amazon Q index.
" + "Application$displayName": "The name of the Amazon Q Business application.
", + "CreateApplicationRequest$displayName": "A name for the Amazon Q Business application.
", + "GetApplicationResponse$displayName": "The name of the Amazon Q Business application.
", + "UpdateApplicationRequest$displayName": "A name for the Amazon Q Business application.
", + "UpdateIndexRequest$displayName": "The name of the Amazon Q Business index.
" } }, "ApplicationStatus": { "base": null, "refs": { - "Application$status": "The status of the Amazon Q application. The application is ready to use when the status is ACTIVE.
The status of the Amazon Q application.
" + "Application$status": "The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
The status of the Amazon Q Business application.
" } }, "Applications": { "base": null, "refs": { - "ListApplicationsResponse$applications": "An array of summary information on the configuration of one or more Amazon Q applications.
" + "ListApplicationsResponse$applications": "An array of summary information on the configuration of one or more Amazon Q Business applications.
" } }, "AppliedAttachmentsConfiguration": { @@ -275,6 +275,12 @@ "GetApplicationResponse$attachmentsConfiguration": "Settings for whether end users can upload files directly during chat.
" } }, + "AppliedCreatorModeConfiguration": { + "base": "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.
", + "refs": { + "GetChatControlsConfigurationResponse$creatorModeConfiguration": "The configuration details for CREATOR_MODE.
A file directly uploaded into a web experience chat.
", "refs": { @@ -324,7 +330,7 @@ "base": null, "refs": { "ChatSyncOutput$failedAttachments": "A list of files which failed to upload during chat.
", - "Message$attachments": "A file directly uploaded into an Amazon Q web experience chat.
" + "Message$attachments": "A file directly uploaded into an Amazon Q Business web experience chat.
" } }, "AttributeFilter": { @@ -332,7 +338,7 @@ "refs": { "AttributeFilter$notFilter": "Performs a logical NOT operation on all supplied filters.
Enables filtering of Amazon Q web experience responses based on document attributes or metadata fields.
" + "ChatSyncInput$attributeFilter": "Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
" } }, "AttributeFilters": { @@ -384,7 +390,7 @@ "base": null, "refs": { "AttachmentInput$data": "The data contained within the uploaded file.
", - "DocumentContent$blob": "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.
A list of phrases blocked from a Amazon Q web experience chat.
", - "BlockedPhrasesConfigurationUpdate$blockedPhrasesToCreateOrUpdate": "Creates or updates a blocked phrases configuration in your Amazon Q application.
", - "BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete": "Deletes a blocked phrases configuration in your Amazon Q application.
" + "BlockedPhrasesConfiguration$blockedPhrases": "A list of phrases blocked from a Amazon Q Business web experience chat.
", + "BlockedPhrasesConfigurationUpdate$blockedPhrasesToCreateOrUpdate": "Creates or updates a blocked phrases configuration in your Amazon Q Business application.
", + "BlockedPhrasesConfigurationUpdate$blockedPhrasesToDelete": "Deletes a blocked phrases configuration in your Amazon Q Business application.
" } }, "BlockedPhrasesConfiguration": { @@ -408,7 +414,7 @@ } }, "BlockedPhrasesConfigurationUpdate": { - "base": "Updates a blocked phrases configuration in your Amazon Q application.
", + "base": "Updates a blocked phrases configuration in your Amazon Q Business application.
", "refs": { "UpdateChatControlsConfigurationRequest$blockedPhrasesConfigurationUpdate": "The phrases blocked from chat by your chat control configuration.
" } @@ -425,6 +431,18 @@ "DateAttributeBoostingConfiguration$boostingDurationInSeconds": "Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.
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": { + "base": "Configuration information for Amazon Q Business conversation modes.
For more information, see Admin controls and guardrails and Conversation settings.
", + "refs": { + "ChatSyncInput$chatModeConfiguration": "The chat mode configuration for an Amazon Q Business application.
" + } + }, "ChatSyncInput": { "base": null, "refs": { @@ -439,14 +457,14 @@ "base": null, "refs": { "ChatSyncInput$clientToken": "A token that you provide to identify a chat request.
", - "CreateApplicationRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q application.
", + "CreateApplicationRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business application.
", "CreateDataSourceRequest$clientToken": "A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.
A token that you provide to identify the request to create your Amazon Q plugin.
", - "CreateRetrieverRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q application retriever.
", - "CreateUserRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q user mapping.
", - "CreateWebExperienceRequest$clientToken": "A token you provide to identify a request to create an Amazon Q web experience.
", - "UpdateChatControlsConfigurationRequest$clientToken": "A token that you provide to identify the request to update a Amazon Q application chat configuration.
" + "CreatePluginRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business plugin.
", + "CreateRetrieverRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business application retriever.
", + "CreateUserRequest$clientToken": "A token that you provide to identify the request to create your Amazon Q Business user mapping.
", + "CreateWebExperienceRequest$clientToken": "A token you provide to identify a request to create an Amazon Q Business web experience.
", + "UpdateChatControlsConfigurationRequest$clientToken": "A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
" } }, "ConflictException": { @@ -455,13 +473,13 @@ } }, "ContentBlockerRule": { - "base": "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.
", + "base": "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.
", "refs": { - "RuleConfiguration$contentBlockerRule": "A rule for configuring how Amazon Q responds when it encounters a a blocked topic.
" + "RuleConfiguration$contentBlockerRule": "A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
" } }, "ContentRetrievalRule": { - "base": "Rules for retrieving content from data sources connected to a Amazon Q application for a specific topic control configuration.
", + "base": "Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
", "refs": { "RuleConfiguration$contentRetrievalRule": null } @@ -473,7 +491,7 @@ } }, "Conversation": { - "base": "A conversation in an Amazon Q application.
", + "base": "A conversation in an Amazon Q Business application.
", "refs": { "Conversations$member": null } @@ -481,11 +499,11 @@ "ConversationId": { "base": null, "refs": { - "ChatSyncInput$conversationId": "The identifier of the Amazon Q conversation.
", - "ChatSyncOutput$conversationId": "The identifier of the Amazon Q conversation.
", - "Conversation$conversationId": "The identifier of the Amazon Q conversation.
", - "DeleteConversationRequest$conversationId": "The identifier of the Amazon Q web experience conversation being deleted.
", - "ListMessagesRequest$conversationId": "The identifier of the Amazon Q web experience conversation.
", + "ChatSyncInput$conversationId": "The identifier of the Amazon Q Business conversation.
", + "ChatSyncOutput$conversationId": "The identifier of the Amazon Q Business conversation.
", + "Conversation$conversationId": "The identifier of the Amazon Q Business conversation.
", + "DeleteConversationRequest$conversationId": "The identifier of the Amazon Q Business web experience conversation being deleted.
", + "ListMessagesRequest$conversationId": "The identifier of the Amazon Q Business web experience conversation.
", "PutFeedbackRequest$conversationId": "The identifier of the conversation the feedback is attached to.
" } }, @@ -498,7 +516,7 @@ "Conversations": { "base": null, "refs": { - "ListConversationsResponse$conversations": "An array of summary information on the configuration of one or more Amazon Q web experiences.
" + "ListConversationsResponse$conversations": "An array of summary information on the configuration of one or more Amazon Q Business web experiences.
" } }, "CreateApplicationRequest": { @@ -577,8 +595,21 @@ "refs": { } }, + "CreatorModeConfiguration": { + "base": "Configuration information required to invoke chat in CREATOR_MODE.
For more information, see Admin controls and guardrails and Conversation settings.
", + "refs": { + "UpdateChatControlsConfigurationRequest$creatorModeConfiguration": "The configuration details for CREATOR_MODE.
Information about whether creator mode is enabled or disabled for an Amazon Q Business application.
", + "CreatorModeConfiguration$creatorModeControl": "Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.
A data source in an Amazon Q application.
", + "base": "A data source in an Amazon Q Business application.
", "refs": { "DataSources$member": null } @@ -586,14 +617,14 @@ "DataSourceArn": { "base": null, "refs": { - "CreateDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of a data source in an Amazon Q application.
", + "CreateDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
", "GetDataSourceResponse$dataSourceArn": "The Amazon Resource Name (ARN) of the data source.
" } }, "DataSourceConfiguration": { - "base": "Provides the configuration information for an Amazon Q data source.
", + "base": "Provides the configuration information for an Amazon Q Business data source.
", "refs": { - "CreateDataSourceRequest$configuration": "Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
", + "CreateDataSourceRequest$configuration": "Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
", "GetDataSourceResponse$configuration": "The details of how the data source connector is configured.
", "UpdateDataSourceRequest$configuration": null } @@ -602,12 +633,12 @@ "base": null, "refs": { "CreateDataSourceResponse$dataSourceId": "The identifier of the data source connector.
", - "DataSource$dataSourceId": "The identifier of the Amazon Q data source.
", + "DataSource$dataSourceId": "The identifier of the Amazon Q Business data source.
", "DataSourceIds$member": null, "DeleteDataSourceRequest$dataSourceId": "The identifier of the data source connector that you want to delete.
", "DeleteGroupRequest$dataSourceId": "The identifier of the data source linked to the group
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups \"Research\", \"Engineering\", and \"Sales and Marketing\" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete \"Research\" and \"Engineering\" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only \"Sales and Marketing\" should access documents in the Salesforce data source.
", "EligibleDataSource$dataSourceId": "The identifier of the data source.
", - "FailedDocument$dataSourceId": "The identifier of the Amazon Q data source connector that contains the failed document.
", + "FailedDocument$dataSourceId": "The identifier of the Amazon Q Business data source connector that contains the failed document.
", "GetDataSourceRequest$dataSourceId": "The identifier of the data source connector.
", "GetDataSourceResponse$dataSourceId": "The identifier of the data source connector.
", "GetGroupRequest$dataSourceId": "The identifier of the data source the group is attached to.
", @@ -630,7 +661,7 @@ "base": null, "refs": { "CreateDataSourceRequest$displayName": "A name for the data source connector.
", - "DataSource$displayName": "The name of the Amazon Q data source.
", + "DataSource$displayName": "The name of the Amazon Q Business data source.
", "GetDataSourceResponse$displayName": "The name for the data source connector.
", "UpdateDataSourceRequest$displayName": "A name of the data source connector.
" } @@ -638,18 +669,18 @@ "DataSourceStatus": { "base": null, "refs": { - "DataSource$status": "The status of the Amazon Q data source.
", + "DataSource$status": "The status of the Amazon Q Business data source.
", "GetDataSourceResponse$status": "The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
Provides information about an Amazon Q data source connector synchronization job.
", + "base": "Provides information about an Amazon Q Business data source connector synchronization job.
", "refs": { "DataSourceSyncJobs$member": null } }, "DataSourceSyncJobMetrics": { - "base": "Maps a batch delete document request to a specific Amazon Q data source connector sync job.
", + "base": "Maps a batch delete document request to a specific Amazon Q Business data source connector sync job.
", "refs": { "DataSourceSyncJob$metrics": "Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
" } @@ -676,7 +707,7 @@ "DataSourceVpcConfiguration": { "base": "Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
", "refs": { - "CreateDataSourceRequest$vpcConfiguration": "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.
", + "CreateDataSourceRequest$vpcConfiguration": "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.
", "GetDataSourceResponse$vpcConfiguration": "Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.
", "UpdateDataSourceRequest$vpcConfiguration": null } @@ -688,7 +719,7 @@ } }, "DateAttributeBoostingConfiguration": { - "base": "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.
", + "base": "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.
", "refs": { "DocumentAttributeBoostingConfiguration$dateConfiguration": "Provides information on boosting DATE type document attributes.
A document deleted from an Amazon Q data source connector.
", + "base": "A document deleted from an Amazon Q Business data source connector.
", "refs": { "DeleteDocuments$member": null } @@ -742,7 +773,7 @@ "DeleteDocuments": { "base": null, "refs": { - "BatchDeleteDocumentRequest$documents": "Documents deleted from the Amazon Q index.
" + "BatchDeleteDocumentRequest$documents": "Documents deleted from the Amazon Q Business index.
" } }, "DeleteGroupRequest": { @@ -808,19 +839,19 @@ "Description": { "base": null, "refs": { - "CreateApplicationRequest$description": "A description for the Amazon Q application.
", + "CreateApplicationRequest$description": "A description for the Amazon Q Business application.
", "CreateDataSourceRequest$description": "A description for the data source connector.
", - "CreateIndexRequest$description": "A description for the Amazon Q index.
", - "GetApplicationResponse$description": "A description for the Amazon Q application.
", + "CreateIndexRequest$description": "A description for the Amazon Q Business index.
", + "GetApplicationResponse$description": "A description for the Amazon Q Business application.
", "GetDataSourceResponse$description": "The description for the data source connector.
", - "GetIndexResponse$description": "The description for the Amazon Q index.
", - "UpdateApplicationRequest$description": "A description for the Amazon Q application.
", + "GetIndexResponse$description": "The description for the Amazon Q Business index.
", + "UpdateApplicationRequest$description": "A description for the Amazon Q Business application.
", "UpdateDataSourceRequest$description": "The description of the data source connector.
", - "UpdateIndexRequest$description": "The description of the Amazon Q index.
" + "UpdateIndexRequest$description": "The description of the Amazon Q Business index.
" } }, "Document": { - "base": "A document in an Amazon Q application.
", + "base": "A document in an Amazon Q Business application.
", "refs": { "Documents$member": null } @@ -828,18 +859,18 @@ "DocumentAttribute": { "base": "A document attribute or metadata field.
", "refs": { - "AttributeFilter$containsAll": "Returns true when a document contains all the specified document attributes or metadata fields.
Returns true when a document contains any of the specified document attributes or metadata fields.
Performs an equals operation on two document attributes or metadata fields.
", - "AttributeFilter$greaterThan": "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 or equals 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. Use with a document attribute of type Date or Long.
Performs a less than or equals operation on two document attributes or metadata fields. Use with a document attribute of type Date or Long.
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. Supported for the following document attribute value types: dateValue, longValue, stringListValue and stringValue.
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. 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. Supported for the following document attribute value types: dateValue and longValue.
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.Supported for the following document attribute value type: dateValue and longValue.
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.
", + "base": "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.
", "refs": { "DocumentAttributeBoostingOverrideMap$value": null } @@ -856,13 +887,13 @@ "DocumentAttributeBoostingOverrideMap": { "base": null, "refs": { - "NativeIndexConfiguration$boostingOverride": "Overrides the default boosts applied by Amazon Q to supported document attribute data types.
" + "NativeIndexConfiguration$boostingOverride": "Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.
" } }, "DocumentAttributeCondition": { - "base": "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 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.
", + "HookConfiguration$invocationCondition": "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.
", "InlineDocumentEnrichmentConfiguration$condition": null } }, @@ -884,7 +915,7 @@ "refs": { "DocumentAttribute$name": "The identifier for the attribute.
", "DocumentAttributeBoostingOverrideMap$key": null, - "DocumentAttributeCondition$key": "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 identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
" } }, @@ -895,7 +926,7 @@ } }, "DocumentAttributeTarget": { - "base": "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 .
Custom attributes to apply to the document for refining Amazon Q web experience responses.
" + "Document$attributes": "Custom attributes to apply to the document for refining Amazon Q Business web experience responses.
" } }, "DocumentContent": { @@ -939,7 +970,7 @@ } }, "DocumentDetails": { - "base": "The details of a document within an Amazon Q index.
", + "base": "The details of a document within an Amazon Q Business index.
", "refs": { "DocumentDetailList$member": null } @@ -965,7 +996,7 @@ "DeleteDocument$documentId": "The identifier of the deleted document.
", "Document$id": "The identifier of the document.
", "DocumentDetails$documentId": "The identifier of the document.
", - "FailedDocument$id": "The identifier of the document that couldn't be removed from the Amazon Q index.
" + "FailedDocument$id": "The identifier of the document that couldn't be removed from the Amazon Q Business index.
" } }, "DocumentStatus": { @@ -981,7 +1012,7 @@ } }, "EligibleDataSource": { - "base": "The identifier of the data source Amazon Q will generate responses from.
", + "base": "The identifier of the data source Amazon Q Business will generate responses from.
", "refs": { "EligibleDataSources$member": null } @@ -989,14 +1020,14 @@ "EligibleDataSources": { "base": null, "refs": { - "ContentRetrievalRule$eligibleDataSources": "Specifies data sources in a Amazon Q application to use for content generation.
" + "ContentRetrievalRule$eligibleDataSources": "Specifies data sources in a Amazon Q Business application to use for content generation.
" } }, "EncryptionConfiguration": { - "base": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q. Amazon Q doesn't support asymmetric keys.
", + "base": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.
", "refs": { - "CreateApplicationRequest$encryptionConfiguration": "The identifier of the KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
", - "GetApplicationResponse$encryptionConfiguration": "The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q doesn't support asymmetric keys.
" + "CreateApplicationRequest$encryptionConfiguration": "The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
", + "GetApplicationResponse$encryptionConfiguration": "The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.
" } }, "ErrorCode": { @@ -1055,7 +1086,7 @@ } }, "FailedDocument": { - "base": "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.
", + "base": "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.
", "refs": { "FailedDocuments$member": null } @@ -1063,8 +1094,8 @@ "FailedDocuments": { "base": null, "refs": { - "BatchDeleteDocumentResponse$failedDocuments": "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.
", - "BatchPutDocumentResponse$failedDocuments": "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.
" + "BatchDeleteDocumentResponse$failedDocuments": "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.
", + "BatchPutDocumentResponse$failedDocuments": "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.
" } }, "GetApplicationRequest": { @@ -1158,7 +1189,7 @@ } }, "GroupMembers": { - "base": "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.
", + "base": "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.
", "refs": { "PutGroupRequest$groupMembers": null } @@ -1206,14 +1237,20 @@ } }, "HookConfiguration": { - "base": "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.
", + "base": "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.
", "refs": { "DocumentEnrichmentConfiguration$postExtractionHookConfiguration": null, "DocumentEnrichmentConfiguration$preExtractionHookConfiguration": null } }, + "IdcApplicationArn": { + "base": null, + "refs": { + "GetApplicationResponse$identityCenterApplicationArn": "The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
" + } + }, "Index": { - "base": "Summary information for your Amazon Q index.
", + "base": "Summary information for your Amazon Q Business index.
", "refs": { "Indices$member": null } @@ -1221,59 +1258,59 @@ "IndexArn": { "base": null, "refs": { - "CreateIndexResponse$indexArn": "The Amazon Resource Name (ARN) of an Amazon Q index.
", - "GetIndexResponse$indexArn": "The Amazon Resource Name (ARN) of the Amazon Q index.
" + "CreateIndexResponse$indexArn": "The Amazon Resource Name (ARN) of an Amazon Q Business index.
", + "GetIndexResponse$indexArn": "The Amazon Resource Name (ARN) of the Amazon Q Business index.
" } }, "IndexCapacityConfiguration": { "base": "Provides information about index capacity configuration.
", "refs": { "CreateIndexRequest$capacityConfiguration": "The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.
", - "GetIndexResponse$capacityConfiguration": "The storage capacity units chosen for your Amazon Q index.
", - "UpdateIndexRequest$capacityConfiguration": "The storage capacity units you want to provision for your Amazon Q index. You can add and remove capacity to fit your usage needs.
" + "GetIndexResponse$capacityConfiguration": "The storage capacity units chosen for your Amazon Q Business index.
", + "UpdateIndexRequest$capacityConfiguration": "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.
" } }, "IndexCapacityInteger": { "base": null, "refs": { - "IndexCapacityConfiguration$units": "The number of storage units configured for an Amazon Q index.
" + "IndexCapacityConfiguration$units": "The number of storage units configured for an Amazon Q Business index.
" } }, "IndexId": { "base": null, "refs": { - "BatchDeleteDocumentRequest$indexId": "The identifier of the Amazon Q index that contains the documents to delete.
", - "BatchPutDocumentRequest$indexId": "The identifier of the Amazon Q index to add the documents to.
", + "BatchDeleteDocumentRequest$indexId": "The identifier of the Amazon Q Business index that contains the documents to delete.
", + "BatchPutDocumentRequest$indexId": "The identifier of the Amazon Q Business index to add the documents to.
", "CreateDataSourceRequest$indexId": "The identifier of the index that you want to use with the data source connector.
", - "CreateIndexResponse$indexId": "The identifier for the Amazon Q index.
", + "CreateIndexResponse$indexId": "The identifier for the Amazon Q Business index.
", "DeleteDataSourceRequest$indexId": "The identifier of the index used with the data source connector.
", "DeleteGroupRequest$indexId": "The identifier of the index you want to delete the group from.
", - "DeleteIndexRequest$indexId": "The identifier of the Amazon Q index.
", + "DeleteIndexRequest$indexId": "The identifier of the Amazon Q Business index.
", "EligibleDataSource$indexId": "The identifier of the index the data source is attached to.
", "GetDataSourceRequest$indexId": "The identfier of the index used with the data source connector.
", "GetDataSourceResponse$indexId": "The identifier of the index linked to the data source connector.
", "GetGroupRequest$indexId": "The identifier of the index the group is attached to.
", - "GetIndexRequest$indexId": "The identifier of the Amazon Q index you want information on.
", - "GetIndexResponse$indexId": "The identifier of the Amazon Q index.
", + "GetIndexRequest$indexId": "The identifier of the Amazon Q Business index you want information on.
", + "GetIndexResponse$indexId": "The identifier of the Amazon Q Business index.
", "Index$indexId": "The identifier for the index.
", - "ListDataSourceSyncJobsRequest$indexId": "The identifier of the index used with the Amazon Q data source connector.
", + "ListDataSourceSyncJobsRequest$indexId": "The identifier of the index used with the Amazon Q Business data source connector.
", "ListDataSourcesRequest$indexId": "The identifier of the index used with one or more data source connectors.
", "ListDocumentsRequest$indexId": "The identifier of the index the documents are attached to.
", "ListGroupsRequest$indexId": "The identifier of the index for getting a list of groups mapped to users.
", - "NativeIndexConfiguration$indexId": "The identifier for the Amazon Q index.
", + "NativeIndexConfiguration$indexId": "The identifier for the Amazon Q Business index.
", "PutGroupRequest$indexId": "The identifier of the index in which you want to map users to their groups.
", "StartDataSourceSyncJobRequest$indexId": "The identifier of the index used with the data source connector.
", - "StopDataSourceSyncJobRequest$indexId": "The identifier of the index used with the Amazon Q data source connector.
", + "StopDataSourceSyncJobRequest$indexId": "The identifier of the index used with the Amazon Q Business data source connector.
", "UpdateDataSourceRequest$indexId": "The identifier of the index attached to the data source connector.
", - "UpdateIndexRequest$indexId": "The identifier of the Amazon Q index.
", + "UpdateIndexRequest$indexId": "The identifier of the Amazon Q Business index.
", "UserAlias$indexId": "The identifier of the index that the user aliases are associated with.
" } }, "IndexName": { "base": null, "refs": { - "CreateIndexRequest$displayName": "A name for the Amazon Q index.
", - "GetIndexResponse$displayName": "The name of the Amazon Q index.
", + "CreateIndexRequest$displayName": "A name for the Amazon Q Business index.
", + "GetIndexResponse$displayName": "The name of the Amazon Q Business index.
", "Index$displayName": "The name of the index.
" } }, @@ -1309,7 +1346,7 @@ } }, "InlineDocumentEnrichmentConfiguration": { - "base": "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.
", + "base": "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.
", "refs": { "InlineDocumentEnrichmentConfigurations$member": null } @@ -1317,27 +1354,33 @@ "InlineDocumentEnrichmentConfigurations": { "base": null, "refs": { - "DocumentEnrichmentConfiguration$inlineConfigurations": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q.
" + "DocumentEnrichmentConfiguration$inlineConfigurations": "Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
" + } + }, + "InstanceArn": { + "base": null, + "refs": { + "CreateApplicationRequest$identityCenterInstanceArn": "The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
" } }, "Integer": { "base": null, "refs": { "ActionReviewPayloadField$displayOrder": "The display order of fields in a payload.
", - "SourceAttribution$citationNumber": "The number attached to a citation in an Amazon Q generated response.
", + "SourceAttribution$citationNumber": "The number attached to a citation in an Amazon Q Business generated response.
", "TextSegment$beginOffset": "The zero-based location in the response string where the source attribution starts.
", "TextSegment$endOffset": "The zero-based location in the response string where the source attribution ends.
" } }, "InternalServerException": { - "base": "An issue occurred with the internal server used for your Amazon Q service. Wait some minutes and try again, or contact Support for help.
", + "base": "An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
", "refs": { } }, "KendraIndexConfiguration": { "base": "Stores an Amazon Kendra index as a retriever.
", "refs": { - "RetrieverConfiguration$kendraIndexConfiguration": "Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q application is configured.
" + "RetrieverConfiguration$kendraIndexConfiguration": "Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
" } }, "KendraIndexId": { @@ -1349,7 +1392,7 @@ "KmsKeyId": { "base": null, "refs": { - "EncryptionConfiguration$kmsKeyId": "The identifier of the KMS key. Amazon Q doesn't support asymmetric keys.
" + "EncryptionConfiguration$kmsKeyId": "The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.
" } }, "LambdaArn": { @@ -1498,13 +1541,13 @@ "MaxResultsIntegerForListApplications": { "base": null, "refs": { - "ListApplicationsRequest$maxResults": "The maximum number of Amazon Q applications to return.
" + "ListApplicationsRequest$maxResults": "The maximum number of Amazon Q Business applications to return.
" } }, "MaxResultsIntegerForListConversations": { "base": null, "refs": { - "ListConversationsRequest$maxResults": "The maximum number of Amazon Q conversations to return.
" + "ListConversationsRequest$maxResults": "The maximum number of Amazon Q Business conversations to return.
" } }, "MaxResultsIntegerForListDataSources": { @@ -1558,7 +1601,7 @@ "MaxResultsIntegerForListWebExperiencesRequest": { "base": null, "refs": { - "ListWebExperiencesRequest$maxResults": "The maximum number of Amazon Q Web Experiences to return.
" + "ListWebExperiencesRequest$maxResults": "The maximum number of Amazon Q Business Web Experiences to return.
" } }, "MemberGroup": { @@ -1603,7 +1646,7 @@ } }, "Message": { - "base": "A message in an Amazon Q web experience.
", + "base": "A message in an Amazon Q Business web experience.
", "refs": { "Messages$member": null } @@ -1611,21 +1654,21 @@ "MessageBody": { "base": null, "refs": { - "Message$body": "The content of the Amazon Q web experience message.
" + "Message$body": "The content of the Amazon Q Business web experience message.
" } }, "MessageId": { "base": null, "refs": { "ChatSyncInput$parentMessageId": "The identifier of the previous end user text input message in a conversation.
", - "ChatSyncOutput$systemMessageId": "The identifier of an Amazon Q AI generated message within the conversation.
", - "ChatSyncOutput$userMessageId": "The identifier of an Amazon Q end user text input message within the conversation.
" + "ChatSyncOutput$systemMessageId": "The identifier of an Amazon Q Business AI generated message within the conversation.
", + "ChatSyncOutput$userMessageId": "The identifier of an Amazon Q Business end user text input message within the conversation.
" } }, "MessageType": { "base": null, "refs": { - "Message$type": "The type of Amazon Q message, whether HUMAN or AI generated.
The type of Amazon Q Business message, whether HUMAN or AI generated.
Configuration information for an Amazon Q index.
", + "base": "Configuration information for an Amazon Q Business index.
", "refs": { - "RetrieverConfiguration$nativeIndexConfiguration": "Provides information on how a Amazon Q index used as a retriever for your Amazon Q application is configured.
" + "RetrieverConfiguration$nativeIndexConfiguration": "Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.
" } }, "NextToken": { "base": null, "refs": { - "GetChatControlsConfigurationRequest$nextToken": "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 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 returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q applications.
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.
", - "ListConversationsRequest$nextToken": "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 response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
", - "ListDataSourceSyncJobsRequest$nextToken": "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 response is truncated, Amazon Q returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
", - "ListDataSourcesRequest$nextToken": "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 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.
", - "ListDocumentsRequest$nextToken": "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 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.
", - "ListGroupsResponse$nextToken": "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.
", - "ListIndicesRequest$nextToken": "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.
", - "ListIndicesResponse$nextToken": "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.
", - "ListMessagesRequest$nextToken": "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 response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
", - "ListPluginsRequest$nextToken": "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 returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
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 response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of retrievers.
", - "ListWebExperiencesRequest$nextToken": "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 response is truncated, Amazon Q returns this token, which you can use in a later request to list the next set of messages.
" + "GetChatControlsConfigurationRequest$nextToken": "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.
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.
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.
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$nextToken": "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 Business returns this token, which you can use in a later request to list the next set of messages.
", + "ListDataSourceSyncJobsRequest$nextToken": "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 Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.
", + "ListDataSourcesRequest$nextToken": "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 Business returns this token. You can use this token in a subsequent request to retrieve the next set of data source connectors.
", + "ListDocumentsRequest$nextToken": "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 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 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.
", + "ListGroupsResponse$nextToken": "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.
", + "ListIndicesRequest$nextToken": "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.
", + "ListIndicesResponse$nextToken": "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.
", + "ListMessagesRequest$nextToken": "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.
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.
", + "ListPluginsRequest$nextToken": "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 Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
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 Business returns this token, which you can use in a later request to list the next set of retrievers.
", + "ListWebExperiencesRequest$nextToken": "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 Business returns this token, which you can use in a later request to list the next set of messages.
" } }, "NumberAttributeBoostingConfiguration": { - "base": "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.
", + "base": "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.
", "refs": { "DocumentAttributeBoostingConfiguration$numberConfiguration": "Provides information on boosting NUMBER type document attributes.
Information about an Amazon Q plugin and its configuration.
", + "base": "Information about an Amazon Q Business plugin and its configuration.
", "refs": { "Plugins$member": null } @@ -1735,13 +1778,19 @@ } }, "PluginAuthConfiguration": { - "base": "Authentication configuration information for an Amazon Q plugin.
", + "base": "Authentication configuration information for an Amazon Q Business plugin.
", "refs": { "CreatePluginRequest$authConfiguration": null, "GetPluginResponse$authConfiguration": null, "UpdatePluginRequest$authConfiguration": "The authentication configuration the plugin is using.
" } }, + "PluginConfiguration": { + "base": "Configuration information required to invoke chat in PLUGIN_MODE.
For more information, see Admin controls and guardrails, Plugins, and Conversation settings.
", + "refs": { + "ChatModeConfiguration$pluginConfiguration": "Configuration information required to invoke chat in PLUGIN_MODE.
The identifier of the plugin.
", "GetPluginResponse$pluginId": "The identifier of the plugin.
", "Plugin$pluginId": "The identifier of the plugin.
", + "PluginConfiguration$pluginId": "The identifier of the plugin you want to use.
", "UpdatePluginRequest$pluginId": "The identifier of the plugin.
" } }, @@ -1788,7 +1838,7 @@ } }, "Principal": { - "base": "Provides user and group information used for filtering documents to use for generating Amazon Q conversation responses.
", + "base": "Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
", "refs": { "Principals$member": null } @@ -1841,12 +1891,12 @@ "ResponseScope": { "base": null, "refs": { - "GetChatControlsConfigurationResponse$responseScope": "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.
", + "GetChatControlsConfigurationResponse$responseScope": "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.
", "UpdateChatControlsConfigurationRequest$responseScope": "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.
" } }, "Retriever": { - "base": "Summary information for the retriever used for your Amazon Q application.
", + "base": "Summary information for the retriever used for your Amazon Q Business application.
", "refs": { "Retrievers$member": null } @@ -1859,7 +1909,7 @@ } }, "RetrieverConfiguration": { - "base": "Provides information on how the retriever used for your Amazon Q application is configured.
", + "base": "Provides information on how the retriever used for your Amazon Q Business application is configured.
", "refs": { "CreateRetrieverRequest$configuration": null, "GetRetrieverResponse$configuration": null, @@ -1873,7 +1923,7 @@ "DeleteRetrieverRequest$retrieverId": "The identifier of the retriever being deleted.
", "GetRetrieverRequest$retrieverId": "The identifier of the retriever.
", "GetRetrieverResponse$retrieverId": "The identifier of the retriever.
", - "Retriever$retrieverId": "The identifier of the retriever used by your Amazon Q application.
", + "Retriever$retrieverId": "The identifier of the retriever used by your Amazon Q Business application.
", "UpdateRetrieverRequest$retrieverId": "The identifier of your retriever.
" } }, @@ -1910,24 +1960,26 @@ "RoleArn": { "base": null, "refs": { - "BasicAuthConfiguration$roleArn": "The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
", + "BasicAuthConfiguration$roleArn": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
", "BatchPutDocumentRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.
", "CreateApplicationRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
", "CreateDataSourceRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
", - "CreateRetrieverRequest$roleArn": "The ARN of an IAM role used by Amazon Q to access the basic authentication credentials stored in a Secrets Manager secret.
", + "CreateRetrieverRequest$roleArn": "The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
", + "CreateWebExperienceRequest$roleArn": "The Amazon Resource Name (ARN) of the service role attached to your web experience.
", "GetApplicationResponse$roleArn": "The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.
", "GetDataSourceResponse$roleArn": "The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
", "GetRetrieverResponse$roleArn": "The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
", + "GetWebExperienceResponse$roleArn": "The Amazon Resource Name (ARN) of the service role attached to your web experience.
", "HookConfiguration$roleArn": "The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.
", - "SamlConfiguration$roleArn": "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.
", - "UpdateApplicationRequest$roleArn": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q permission to access Amazon CloudWatch logs and metrics.
", + "OAuth2ClientCredentialConfiguration$roleArn": "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.
", + "SamlConfiguration$roleArn": "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.
", + "UpdateApplicationRequest$roleArn": "An Amazon Web Services Identity and Access Management (IAM) role that gives Amazon Q Business permission to access Amazon CloudWatch logs and metrics.
", "UpdateDataSourceRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
", "UpdateRetrieverRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role with permission to access the retriever and required resources.
" } }, "Rule": { - "base": "Guardrail rules for an Amazon Q application. Amazon Q supports only one rule at a time.
", + "base": "Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
", "refs": { "Rules$member": null } @@ -1951,7 +2003,7 @@ } }, "S3": { - "base": "Information required for Amazon Q to find a specific file in an Amazon S3 bucket.
", + "base": "Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
", "refs": { "DocumentContent$s3": "The path to the document in an Amazon S3 bucket.
" } @@ -1977,7 +2029,7 @@ } }, "SamlConfiguration": { - "base": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q needs to deploy a Amazon Q web experience.
", + "base": "Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
", "refs": { "WebExperienceAuthConfiguration$samlConfiguration": null } @@ -2004,16 +2056,16 @@ "SecurityGroupIds": { "base": null, "refs": { - "DataSourceVpcConfiguration$securityGroupIds": "A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q to connect to the data source.
" + "DataSourceVpcConfiguration$securityGroupIds": "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.
" } }, "ServiceQuotaExceededException": { - "base": "You have exceeded the set limits for your Amazon Q service.
", + "base": "You have exceeded the set limits for your Amazon Q Business service.
", "refs": { } }, "SourceAttribution": { - "base": "The documents used to generate an Amazon Q web experience response.
", + "base": "The documents used to generate an Amazon Q Business web experience response.
", "refs": { "SourceAttributions$member": null } @@ -2022,7 +2074,7 @@ "base": null, "refs": { "ChatSyncOutput$sourceAttributions": "The source documents used to generate the conversation response.
", - "Message$sourceAttribution": "The source documents used to generate Amazon Q web experience message.
" + "Message$sourceAttribution": "The source documents used to generate Amazon Q Business web experience message.
" } }, "StartDataSourceSyncJobRequest": { @@ -2059,21 +2111,21 @@ "ConflictException$resourceId": "The identifier of the resource affected.
", "ConflictException$resourceType": "The type of the resource affected.
", "CreateUserRequest$userId": "The user emails attached to a user mapping.
", - "DataSource$type": "The type of the Amazon Q data source.
", + "DataSource$type": "The type of the Amazon Q Business data source.
", "DataSourceSyncJob$dataSourceErrorCode": "If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
", "DeleteUserRequest$userId": "The user email being deleted.
", "DocumentAttributeConfiguration$name": "The name of the document attribute.
", "DocumentAttributeStringListValue$member": null, "GetDataSourceResponse$type": "The type of the data source connector. For example, S3.
The user email address attached to the user.
", - "Message$messageId": "The identifier of the Amazon Q web experience message.
", + "Message$messageId": "The identifier of the Amazon Q Business web experience message.
", "ResourceNotFoundException$resourceId": "The identifier of the resource affected.
", "ResourceNotFoundException$resourceType": "The type of the resource affected.
", "ServiceQuotaExceededException$resourceId": "The identifier of the resource affected.
", "ServiceQuotaExceededException$resourceType": "The type of the resource affected.
", "SourceAttribution$snippet": "The content extract from the document on which the generated response is based.
", - "SourceAttribution$title": "The title of the document which is the source for the Amazon Q generated response.
", - "SourceAttribution$url": "The URL of the document which is the source for the Amazon Q generated response.
", + "SourceAttribution$title": "The title of the document which is the source for the Amazon Q Business generated response.
", + "SourceAttribution$url": "The URL of the document which is the source for the Amazon Q Business generated response.
", "StringAttributeValueBoosting$key": null, "UpdateUserRequest$userId": "The email id attached to the user.
", "UserAlias$userId": "The identifier of the user id associated with the user aliases.
", @@ -2084,7 +2136,7 @@ } }, "StringAttributeBoostingConfiguration": { - "base": "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.
", + "base": "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.
", "refs": { "DocumentAttributeBoostingConfiguration$stringConfiguration": "Provides information on boosting STRING type document attributes.
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.
", + "base": "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.
", "refs": { "DocumentAttributeBoostingConfiguration$stringListConfiguration": "Provides information on boosting STRING_LIST type document attributes.
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.
The schedule for Amazon Q to update the index.
", + "CreateDataSourceRequest$syncSchedule": "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.
The schedule for Amazon Q Business to update the index.
", "UpdateDataSourceRequest$syncSchedule": "The chosen update frequency for your data source.
" } }, @@ -2150,14 +2202,14 @@ "TagKey": { "base": null, "refs": { - "Tag$key": "The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q application or data source.
", + "Tag$key": "The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.
", "TagKeys$member": null } }, "TagKeys": { "base": null, "refs": { - "UntagResourceRequest$tagKeys": "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.
" + "UntagResourceRequest$tagKeys": "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.
" } }, "TagResourceRequest": { @@ -2179,14 +2231,14 @@ "Tags": { "base": null, "refs": { - "CreateApplicationRequest$tags": "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: _ . : / = + - @.
", + "CreateApplicationRequest$tags": "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: _ . : / = + - @.
", "CreateDataSourceRequest$tags": "A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateIndexRequest$tags": "A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreatePluginRequest$tags": "A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", "CreateRetrieverRequest$tags": "A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
", - "CreateWebExperienceRequest$tags": "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: _ . : / = + - @.
", - "ListTagsForResourceResponse$tags": "A list of tags associated with the Amazon Q application or data source.
", - "TagResourceRequest$tags": "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.
" + "CreateWebExperienceRequest$tags": "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: _ . : / = + - @.
", + "ListTagsForResourceResponse$tags": "A list of tags associated with the Amazon Q Business application or data source.
", + "TagResourceRequest$tags": "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.
" } }, "TextDocumentStatistics": { @@ -2215,42 +2267,42 @@ "Timestamp": { "base": null, "refs": { - "Application$createdAt": "The Unix timestamp when the Amazon Q application was created.
", - "Application$updatedAt": "The Unix timestamp when the Amazon Q application was last updated.
", + "Application$createdAt": "The Unix timestamp when the Amazon Q Business application was created.
", + "Application$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "Conversation$startTime": "The start time of the conversation.
", - "DataSource$createdAt": "The Unix timestamp when the Amazon Q data source was created.
", - "DataSource$updatedAt": "The Unix timestamp when the Amazon Q data source was last updated.
", + "DataSource$createdAt": "The Unix timestamp when the Amazon Q Business data source was created.
", + "DataSource$updatedAt": "The Unix timestamp when the Amazon Q Business data source was last updated.
", "DataSourceSyncJob$endTime": "The Unix timestamp when the synchronization job completed.
", "DataSourceSyncJob$startTime": "The Unix time stamp when the data source synchronization job started.
", "DocumentAttributeValue$dateValue": "A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
", "DocumentDetails$createdAt": "The timestamp for when the document was created.
", "DocumentDetails$updatedAt": "The timestamp for when the document was last updated.
", - "GetApplicationResponse$createdAt": "The Unix timestamp when the Amazon Q application was last updated.
", - "GetApplicationResponse$updatedAt": "The Unix timestamp when the Amazon Q application was last updated.
", + "GetApplicationResponse$createdAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", + "GetApplicationResponse$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "GetDataSourceResponse$createdAt": "The Unix timestamp when the data source connector was created.
", "GetDataSourceResponse$updatedAt": "The Unix timestamp when the data source connector was last updated.
", - "GetIndexResponse$createdAt": "The Unix timestamp when the Amazon Q index was created.
", - "GetIndexResponse$updatedAt": "The Unix timestamp when the Amazon Q index was last updated.
", + "GetIndexResponse$createdAt": "The Unix timestamp when the Amazon Q Business index was created.
", + "GetIndexResponse$updatedAt": "The Unix timestamp when the Amazon Q Business index was last updated.
", "GetPluginResponse$createdAt": "The timestamp for when the plugin was created.
", "GetPluginResponse$updatedAt": "The timestamp for when the plugin was last updated.
", "GetRetrieverResponse$createdAt": "The Unix timestamp when the retriever was created.
", "GetRetrieverResponse$updatedAt": "The Unix timestamp when the retriever was last updated.
", "GetWebExperienceResponse$createdAt": "The Unix timestamp when the retriever was created.
", "GetWebExperienceResponse$updatedAt": "The Unix timestamp when the data source connector was last updated.
", - "GroupStatusDetail$lastUpdatedAt": "The Unix timestamp when the Amazon Q application was last updated.
", + "GroupStatusDetail$lastUpdatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", "Index$createdAt": "The Unix timestamp when the index was created.
", "Index$updatedAt": "The Unix timestamp when the index was last updated.
", "ListDataSourceSyncJobsRequest$endTime": "The end time of the data source connector sync.
", "ListDataSourceSyncJobsRequest$startTime": "The start time of the data source connector sync.
", "ListGroupsRequest$updatedEarlierThan": "The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
The timestamp of the first Amazon Q web experience message.
", + "Message$time": "The timestamp of the first Amazon Q Business web experience message.
", "MessageUsefulnessFeedback$submittedAt": "The timestamp for when the feedback was submitted.
", "Plugin$createdAt": "The timestamp for when the plugin was created.
", "Plugin$updatedAt": "The timestamp for when the plugin was last updated.
", "PutFeedbackRequest$messageCopiedAt": "The timestamp for when the feedback was recorded.
", - "SourceAttribution$updatedAt": "The Unix timestamp when the Amazon Q application was last updated.
", - "WebExperience$createdAt": "The Unix timestamp when the Amazon Q application was last updated.
", - "WebExperience$updatedAt": "The Unix timestamp when your Amazon Q web experience was updated.
" + "SourceAttribution$updatedAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", + "WebExperience$createdAt": "The Unix timestamp when the Amazon Q Business application was last updated.
", + "WebExperience$updatedAt": "The Unix timestamp when your Amazon Q Business web experience was updated.
" } }, "Title": { @@ -2260,7 +2312,7 @@ } }, "TopicConfiguration": { - "base": "The topic specific controls configured for an Amazon Q application.
", + "base": "The topic specific controls configured for an Amazon Q Business application.
", "refs": { "TopicConfigurations$member": null } @@ -2274,7 +2326,7 @@ "TopicConfigurations": { "base": null, "refs": { - "GetChatControlsConfigurationResponse$topicConfigurations": "The topic specific controls configured for a Amazon Q application.
", + "GetChatControlsConfigurationResponse$topicConfigurations": "The topic specific controls configured for a Amazon Q Business application.
", "UpdateChatControlsConfigurationRequest$topicConfigurationsToCreateOrUpdate": "The configured topic specific chat controls you want to update.
", "UpdateChatControlsConfigurationRequest$topicConfigurationsToDelete": "The configured topic specific chat controls you want to delete.
" } @@ -2380,14 +2432,14 @@ "refs": { "CreatePluginRequest$serverUrl": "The source URL used for plugin configuration.
", "GetPluginResponse$serverUrl": "The source URL used for plugin configuration.
", - "GetWebExperienceResponse$defaultEndpoint": "The endpoint of your Amazon Q web experience.
", + "GetWebExperienceResponse$defaultEndpoint": "The endpoint of your Amazon Q Business web experience.
", "Plugin$serverUrl": "The plugin server URL used for configuration.
", "UpdatePluginRequest$serverUrl": "The source URL used for plugin configuration.
", - "WebExperience$defaultEndpoint": "The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully hosted by Amazon Web Services.
" + "WebExperience$defaultEndpoint": "The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully hosted by Amazon Web Services.
" } }, "UserAlias": { - "base": "Aliases attached to a user id within an Amazon Q application.
", + "base": "Aliases attached to a user id within an Amazon Q Business application.
", "refs": { "CreateUserRequestUserAliasesList$member": null, "UserAliases$member": null @@ -2416,8 +2468,8 @@ "refs": { "ChatSyncInput$userId": "The identifier of the user attached to the chat input.
", "DeleteConversationRequest$userId": "The identifier of the user who is deleting the conversation.
", - "ListConversationsRequest$userId": "The identifier of the user involved in the Amazon Q web experience conversation.
", - "ListMessagesRequest$userId": "The identifier of the user involved in the Amazon Q web experience conversation.
", + "ListConversationsRequest$userId": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", + "ListMessagesRequest$userId": "The identifier of the user involved in the Amazon Q Business web experience conversation.
", "PrincipalUser$id": "The identifier of the user.
", "PutFeedbackRequest$userId": "The identifier of the user giving the feedback.
" } @@ -2442,12 +2494,12 @@ } }, "ValidationException": { - "base": "The input doesn't meet the constraints set by the Amazon Q service. Provide the correct input and try again.
", + "base": "The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
", "refs": { } }, "ValidationExceptionField": { - "base": "The input failed to meet the constraints specified by Amazon Q in a specified field.
", + "base": "The input failed to meet the constraints specified by Amazon Q Business in a specified field.
", "refs": { "ValidationExceptionFields$member": null } @@ -2465,7 +2517,7 @@ } }, "WebExperience": { - "base": "Provides information for an Amazon Q web experience.
", + "base": "Provides information for an Amazon Q Business web experience.
", "refs": { "WebExperiences$member": null } @@ -2473,26 +2525,26 @@ "WebExperienceArn": { "base": null, "refs": { - "CreateWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of an Amazon Q web experience.
", - "GetWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q web experience and required resources.
" + "CreateWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
", + "GetWebExperienceResponse$webExperienceArn": "The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.
" } }, "WebExperienceAuthConfiguration": { - "base": "Provides the authorization configuration information needed to deploy a Amazon Q web experience to end users.
", + "base": "Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.
", "refs": { - "GetWebExperienceResponse$authenticationConfiguration": "The authentication configuration information for your Amazon Q web experience.
", - "UpdateWebExperienceRequest$authenticationConfiguration": "The authentication configuration of the Amazon Q web experience.
" + "GetWebExperienceResponse$authenticationConfiguration": "The authentication configuration information for your Amazon Q Business web experience.
", + "UpdateWebExperienceRequest$authenticationConfiguration": "The authentication configuration of the Amazon Q Business web experience.
" } }, "WebExperienceId": { "base": null, "refs": { - "CreateWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q web experience.
", - "DeleteWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience being deleted.
", - "GetWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience.
", - "GetWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q web experience.
", - "UpdateWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q web experience.
", - "WebExperience$webExperienceId": "The identifier of your Amazon Q web experience.
" + "CreateWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q Business web experience.
", + "DeleteWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience being deleted.
", + "GetWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience.
", + "GetWebExperienceResponse$webExperienceId": "The identifier of the Amazon Q Business web experience.
", + "UpdateWebExperienceRequest$webExperienceId": "The identifier of the Amazon Q Business web experience.
", + "WebExperience$webExperienceId": "The identifier of your Amazon Q Business web experience.
" } }, "WebExperienceSamplePromptsControlMode": { @@ -2506,38 +2558,38 @@ "WebExperienceStatus": { "base": null, "refs": { - "GetWebExperienceResponse$status": "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 status of your Amazon Q web experience.
" + "GetWebExperienceResponse$status": "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 status of your Amazon Q Business web experience.
" } }, "WebExperienceSubtitle": { "base": null, "refs": { - "CreateWebExperienceRequest$subtitle": "A subtitle to personalize your Amazon Q web experience.
", - "GetWebExperienceResponse$subtitle": "The subtitle for your Amazon Q web experience.
", - "UpdateWebExperienceRequest$subtitle": "The subtitle of the Amazon Q web experience.
" + "CreateWebExperienceRequest$subtitle": "A subtitle to personalize your Amazon Q Business web experience.
", + "GetWebExperienceResponse$subtitle": "The subtitle for your Amazon Q Business web experience.
", + "UpdateWebExperienceRequest$subtitle": "The subtitle of the Amazon Q Business web experience.
" } }, "WebExperienceTitle": { "base": null, "refs": { - "CreateWebExperienceRequest$title": "The title for your Amazon Q web experience.
", - "GetWebExperienceResponse$title": "The title for your Amazon Q web experience.
", - "UpdateWebExperienceRequest$title": "The title of the Amazon Q web experience.
" + "CreateWebExperienceRequest$title": "The title for your Amazon Q Business web experience.
", + "GetWebExperienceResponse$title": "The title for your Amazon Q Business web experience.
", + "UpdateWebExperienceRequest$title": "The title of the Amazon Q Business web experience.
" } }, "WebExperienceWelcomeMessage": { "base": null, "refs": { - "CreateWebExperienceRequest$welcomeMessage": "The customized welcome message for end users of an Amazon Q web experience.
", - "GetWebExperienceResponse$welcomeMessage": "The customized welcome message for end users of an Amazon Q web experience.
", - "UpdateWebExperienceRequest$welcomeMessage": "A customized welcome message for an end user in an Amazon Q web experience.
" + "CreateWebExperienceRequest$welcomeMessage": "The customized welcome message for end users of an Amazon Q Business web experience.
", + "GetWebExperienceResponse$welcomeMessage": "The customized welcome message for end users of an Amazon Q Business web experience.
", + "UpdateWebExperienceRequest$welcomeMessage": "A customized welcome message for an end user in an Amazon Q Business web experience.
" } }, "WebExperiences": { "base": null, "refs": { - "ListWebExperiencesResponse$webExperiences": "An array of summary information for one or more Amazon Q experiences.
" + "ListWebExperiencesResponse$webExperiences": "An array of summary information for one or more Amazon Q Business experiences.
" } } } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index c7c9d3f262c..f862505cd9e 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -9970,6 +9970,12 @@ "tags" : [ "fips" ] } ] }, + "ca-west-1" : { + "variants" : [ { + "hostname" : "kafka-fips.ca-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "eu-central-1" : { }, "eu-central-2" : { }, "eu-north-1" : { }, @@ -9985,6 +9991,13 @@ "deprecated" : true, "hostname" : "kafka-fips.ca-central-1.amazonaws.com" }, + "fips-ca-west-1" : { + "credentialScope" : { + "region" : "ca-west-1" + }, + "deprecated" : true, + "hostname" : "kafka-fips.ca-west-1.amazonaws.com" + }, "fips-us-east-1" : { "credentialScope" : { "region" : "us-east-1" @@ -23122,8 +23135,32 @@ }, "controltower" : { "endpoints" : { - "us-gov-east-1" : { }, - "us-gov-west-1" : { } + "us-gov-east-1" : { + "variants" : [ { + "hostname" : "controltower-fips.us-gov-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "deprecated" : true, + "hostname" : "controltower-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "variants" : [ { + "hostname" : "controltower-fips.us-gov-west-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "deprecated" : true, + "hostname" : "controltower-fips.us-gov-west-1.amazonaws.com" + } } }, "data-ats.iot" : { diff --git a/service/ec2/api.go b/service/ec2/api.go index cedc4d5ba5f..2e604f27643 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -4006,6 +4006,11 @@ func (c *EC2) CancelSpotFleetRequestsRequest(input *CancelSpotFleetRequestsInput // 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. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -11804,17 +11809,22 @@ func (c *EC2) DeleteFleetsRequest(input *DeleteFleetsInput) (req *request.Reques // 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. +// 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 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. +// - 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. // -// - Up to 1000 instances can be terminated in a single request to delete -// instant fleets. +// - 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet) // in the Amazon EC2 User Guide. @@ -23467,9 +23477,9 @@ func (c *EC2) DescribeInstanceTypeOfferingsRequest(input *DescribeInstanceTypeOf // DescribeInstanceTypeOfferings API operation for Amazon Elastic Compute Cloud. // -// 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. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -23599,8 +23609,8 @@ func (c *EC2) DescribeInstanceTypesRequest(input *DescribeInstanceTypesInput) (r // DescribeInstanceTypes API operation for Amazon Elastic Compute Cloud. // -// 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. +// Describes the specified instance types. By default, all instance types for +// the current Region are described. Alternatively, you can filter the results. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -40523,6 +40533,9 @@ func (c *EC2) GetConsoleScreenshotRequest(input *GetConsoleScreenshotInput) (req // // The returned content is Base64-encoded. // +// For more information, see Instance console output (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output) +// in the Amazon EC2 User Guide. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -47291,9 +47304,9 @@ func (c *EC2) ModifyInstanceMetadataDefaultsRequest(input *ModifyInstanceMetadat // 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) +// 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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) // in the Amazon EC2 User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -65615,6 +65628,8 @@ type CancelSpotFleetRequestsInput struct { // The IDs of the Spot Fleet requests. // + // Constraint: You can specify up to 100 IDs in a single request. + // // SpotFleetRequestIds is a required field SpotFleetRequestIds []*string `locationName:"spotFleetRequestId" locationNameList:"item" type:"list" required:"true"` @@ -71954,11 +71969,11 @@ type CreateFleetError struct { _ struct{} `type:"structure"` // The error code that indicates why the instance could not be launched. For - // more information about error codes, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // more information about error codes, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html). ErrorCode *string `locationName:"errorCode" type:"string"` // The error message that describes why the instance could not be launched. - // For more information about error messages, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html). + // For more information about error messages, see Error codes (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html). ErrorMessage *string `locationName:"errorMessage" type:"string"` // The launch templates and overrides that were used for launching the instances. @@ -84237,6 +84252,9 @@ type DeleteFleetsInput struct { // 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. + // // FleetIds is a required field FleetIds []*string `locationName:"FleetId" type:"list" required:"true"` @@ -98574,14 +98592,26 @@ type DescribeInstanceTypeOfferingsInput struct { // 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 a list of possible values, see + // Instance (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html). // - // * instance-type - The instance type. For example, c5.2xlarge. + // * location - The location. For a list of possible identifiers, see Regions + // and Zones (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html). Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` // 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. LocationType *string `type:"string" enum:"LocationType"` // The maximum number of items to return for this request. To get the next page @@ -98658,7 +98688,7 @@ func (s *DescribeInstanceTypeOfferingsInput) SetNextToken(v string) *DescribeIns type DescribeInstanceTypeOfferingsOutput struct { _ struct{} `type:"structure"` - // The instance types offered. + // The instance types offered in the location. InstanceTypeOfferings []*InstanceTypeOffering `locationName:"instanceTypeOfferingSet" locationNameList:"item" type:"list"` // The token to include in another request to get the next page of items. This @@ -98850,8 +98880,7 @@ type DescribeInstanceTypesInput struct { // can be configured for the instance type. For example, "1" or "1,2". Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"` - // The instance types. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) - // in the Amazon EC2 User Guide. + // The instance types. InstanceTypes []*string `locationName:"InstanceType" type:"list" enum:"InstanceType"` // The maximum number of items to return for this request. To get the next page @@ -98928,8 +98957,7 @@ func (s *DescribeInstanceTypesInput) SetNextToken(v string) *DescribeInstanceTyp type DescribeInstanceTypesOutput struct { _ struct{} `type:"structure"` - // The instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) - // in the Amazon EC2 User Guide. + // The instance type. InstanceTypes []*InstanceTypeInfo `locationName:"instanceTypeSet" locationNameList:"item" type:"list"` // The token to include in another request to get the next page of items. This @@ -150096,11 +150124,10 @@ type ModifyInstanceMetadataDefaultsInput struct { // instance metadata can't be accessed. HttpEndpoint *string `type:"string" enum:"DefaultInstanceMetadataEndpointState"` - // The maximum number of hops that the metadata token can travel. + // The maximum number of hops that the metadata token can travel. To indicate + // no preference, specify -1. // - // Minimum: 1 - // - // Maximum: 64 + // Possible values: Integers from 1 to 64, and -1 to indicate no preference HttpPutResponseHopLimit *int64 `type:"integer"` // Indicates whether IMDSv2 is required. @@ -167250,8 +167277,7 @@ type RequestLaunchTemplateData struct { // The monitoring for the instance. Monitoring *LaunchTemplatesMonitoringRequest `type:"structure"` - // 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. + // The network interfaces for the instance. NetworkInterfaces []*LaunchTemplateInstanceNetworkInterfaceSpecificationRequest `locationName:"NetworkInterface" locationNameList:"InstanceNetworkInterfaceSpecification" type:"list"` // The placement for the instance. @@ -167268,12 +167294,17 @@ type RequestLaunchTemplateData struct { // in the Amazon Elastic Compute Cloud User Guide. RamDiskId *string `type:"string"` - // One or more security group IDs. You can create a security group using CreateSecurityGroup - // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). + // 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. SecurityGroupIds []*string `locationName:"SecurityGroupId" locationNameList:"SecurityGroupId" type:"list"` - // One or more security group names. For a nondefault VPC, you must use security + // 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. SecurityGroups []*string `locationName:"SecurityGroup" locationNameList:"SecurityGroup" type:"list"` // The tags to apply to the resources that are created during instance launch. @@ -171920,26 +171951,15 @@ type RunInstancesInput struct { // Default: false EbsOptimized *bool `locationName:"ebsOptimized" type:"boolean"` - // Deprecated. + // An elastic GPU to associate with the instance. // - // 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. + // Amazon Elastic Graphics reached end of life on January 8, 2024. ElasticGpuSpecification []*ElasticGpuSpecification `locationNameList:"item" type:"list"` - // 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. + // An elastic inference accelerator to associate with the instance. // - // 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. + // Amazon Elastic Inference (EI) is no longer available to new customers. For + // more information, see Amazon Elastic Inference FAQs (http://aws.amazon.com/machine-learning/elastic-inference/faqs/). ElasticInferenceAccelerators []*ElasticInferenceAccelerator `locationName:"ElasticInferenceAccelerator" locationNameList:"item" type:"list"` // If you’re launching an instance into a dual-stack or IPv6-only subnet, @@ -172072,9 +172092,7 @@ type RunInstancesInput struct { // Specifies whether detailed monitoring is enabled for the instance. Monitoring *RunInstancesMonitoringEnabled `type:"structure"` - // 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. + // The network interfaces to associate with the instance. NetworkInterfaces []*InstanceNetworkInterfaceSpecification `locationName:"networkInterface" locationNameList:"item" type:"list"` // The placement for the instance. @@ -172111,13 +172129,13 @@ type RunInstancesInput struct { // (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html). // // If you specify a network interface, you must specify any security groups - // as part of the network interface. + // as part of the network interface instead of using this parameter. SecurityGroupIds []*string `locationName:"SecurityGroupId" locationNameList:"SecurityGroupId" type:"list"` // [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. + // as part of the network interface instead of using this parameter. // // Default: Amazon EC2 uses the default security group. SecurityGroups []*string `locationName:"SecurityGroup" locationNameList:"SecurityGroup" type:"list"` @@ -172125,7 +172143,7 @@ type RunInstancesInput struct { // 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. + // of the network interface instead of using this parameter. SubnetId *string `type:"string"` // The tags to apply to the resources that are created during instance launch. @@ -174219,7 +174237,8 @@ type SearchTransitGatewayRoutesInput struct { // Filters is a required field Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list" required:"true"` - // The maximum number of routes to return. + // The maximum number of routes to return. If a value is not provided, the default + // is 1000. MaxResults *int64 `min:"5" type:"integer"` // The ID of the transit gateway route table. @@ -176549,11 +176568,11 @@ type SpotFleetLaunchSpecification struct { // Enable or disable monitoring for the instances. Monitoring *SpotFleetMonitoring `locationName:"monitoring" type:"structure"` - // One or more network interfaces. If you specify a network interface, you must - // specify subnet IDs and security group IDs using the network interface. + // The network interfaces. // - // SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter - // (EFA). To specify an EFA, you must use LaunchTemplateConfig (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html). + // SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). + // You must use LaunchTemplateConfig (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) + // instead. NetworkInterfaces []*InstanceNetworkInterfaceSpecification `locationName:"networkInterfaceSet" locationNameList:"item" type:"list"` // The placement information. @@ -176566,6 +176585,9 @@ type SpotFleetLaunchSpecification struct { RamdiskId *string `locationName:"ramdiskId" type:"string"` // 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. SecurityGroups []*GroupIdentifier `locationName:"groupSet" locationNameList:"item" type:"list"` // The maximum price per unit hour that you are willing to pay for a Spot Instance. @@ -176580,6 +176602,9 @@ type SpotFleetLaunchSpecification struct { // 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. SubnetId *string `locationName:"subnetId" type:"string"` // The tags to apply during creation. diff --git a/service/qbusiness/api.go b/service/qbusiness/api.go index 8972579777a..44adfb67587 100644 --- a/service/qbusiness/api.go +++ b/service/qbusiness/api.go @@ -57,7 +57,7 @@ func (c *QBusiness) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) // BatchDeleteDocument API operation for QBusiness. // // Asynchronously deletes one or more documents added using the BatchPutDocument -// API from an Amazon Q index. +// 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. @@ -76,8 +76,8 @@ func (c *QBusiness) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -89,8 +89,8 @@ func (c *QBusiness) BatchDeleteDocumentRequest(input *BatchDeleteDocumentInput) // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -161,17 +161,17 @@ func (c *QBusiness) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req * // BatchPutDocument API operation for QBusiness. // -// Adds one or more documents to an Amazon Q index. +// 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 index. +// in an Amazon S3 bucket into an Amazon Q Business index. // -// - add custom attributes to documents in an Amazon Q 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 -// index. +// Business index. // // You can see the progress of the deletion, and any error messages related // to the process, by using CloudWatch. @@ -190,8 +190,8 @@ func (c *QBusiness) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req * // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -203,15 +203,15 @@ func (c *QBusiness) BatchPutDocumentRequest(input *BatchPutDocumentInput) (req * // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BatchPutDocument func (c *QBusiness) BatchPutDocument(input *BatchPutDocumentInput) (*BatchPutDocumentOutput, error) { @@ -278,7 +278,7 @@ func (c *QBusiness) ChatSyncRequest(input *ChatSyncInput) (req *request.Request, // ChatSync API operation for QBusiness. // -// Starts or continues a non-streaming Amazon Q conversation. +// Starts or continues a non-streaming Amazon Q Business conversation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -294,8 +294,8 @@ func (c *QBusiness) ChatSyncRequest(input *ChatSyncInput) (req *request.Request, // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - LicenseNotFoundException @@ -312,8 +312,8 @@ func (c *QBusiness) ChatSyncRequest(input *ChatSyncInput) (req *request.Request, // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -384,7 +384,7 @@ func (c *QBusiness) CreateApplicationRequest(input *CreateApplicationInput) (req // CreateApplication API operation for QBusiness. // -// Creates an Amazon Q application. +// Creates an Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -400,8 +400,8 @@ func (c *QBusiness) CreateApplicationRequest(input *CreateApplicationInput) (req // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -413,15 +413,15 @@ func (c *QBusiness) CreateApplicationRequest(input *CreateApplicationInput) (req // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateApplication func (c *QBusiness) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error) { @@ -488,7 +488,7 @@ func (c *QBusiness) CreateIndexRequest(input *CreateIndexInput) (req *request.Re // CreateIndex API operation for QBusiness. // -// Creates an Amazon Q index. +// 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 @@ -513,8 +513,8 @@ func (c *QBusiness) CreateIndexRequest(input *CreateIndexInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -526,15 +526,15 @@ func (c *QBusiness) CreateIndexRequest(input *CreateIndexInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateIndex func (c *QBusiness) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error) { @@ -601,7 +601,7 @@ func (c *QBusiness) CreatePluginRequest(input *CreatePluginInput) (req *request. // CreatePlugin API operation for QBusiness. // -// Creates an Amazon Q plugin. +// Creates an Amazon Q Business plugin. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -617,8 +617,8 @@ func (c *QBusiness) CreatePluginRequest(input *CreatePluginInput) (req *request. // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -630,15 +630,15 @@ func (c *QBusiness) CreatePluginRequest(input *CreatePluginInput) (req *request. // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreatePlugin func (c *QBusiness) CreatePlugin(input *CreatePluginInput) (*CreatePluginOutput, error) { @@ -705,7 +705,7 @@ func (c *QBusiness) CreateRetrieverRequest(input *CreateRetrieverInput) (req *re // CreateRetriever API operation for QBusiness. // -// Adds a retriever to your Amazon Q application. +// Adds a retriever to your Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -721,8 +721,8 @@ func (c *QBusiness) CreateRetrieverRequest(input *CreateRetrieverInput) (req *re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -734,15 +734,15 @@ func (c *QBusiness) CreateRetrieverRequest(input *CreateRetrieverInput) (req *re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateRetriever func (c *QBusiness) CreateRetriever(input *CreateRetrieverInput) (*CreateRetrieverOutput, error) { @@ -827,8 +827,8 @@ func (c *QBusiness) CreateUserRequest(input *CreateUserInput) (req *request.Requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -840,15 +840,15 @@ func (c *QBusiness) CreateUserRequest(input *CreateUserInput) (req *request.Requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateUser func (c *QBusiness) CreateUser(input *CreateUserInput) (*CreateUserOutput, error) { @@ -915,7 +915,7 @@ func (c *QBusiness) CreateWebExperienceRequest(input *CreateWebExperienceInput) // CreateWebExperience API operation for QBusiness. // -// Creates an Amazon Q web experience. +// Creates an Amazon Q Business web experience. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -931,8 +931,8 @@ func (c *QBusiness) CreateWebExperienceRequest(input *CreateWebExperienceInput) // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -944,15 +944,15 @@ func (c *QBusiness) CreateWebExperienceRequest(input *CreateWebExperienceInput) // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperience func (c *QBusiness) CreateWebExperience(input *CreateWebExperienceInput) (*CreateWebExperienceOutput, error) { @@ -1020,7 +1020,7 @@ func (c *QBusiness) DeleteApplicationRequest(input *DeleteApplicationInput) (req // DeleteApplication API operation for QBusiness. // -// Deletes an Amazon Q application. +// Deletes an Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1036,8 +1036,8 @@ func (c *QBusiness) DeleteApplicationRequest(input *DeleteApplicationInput) (req // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1049,8 +1049,8 @@ func (c *QBusiness) DeleteApplicationRequest(input *DeleteApplicationInput) (req // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1122,7 +1122,7 @@ func (c *QBusiness) DeleteChatControlsConfigurationRequest(input *DeleteChatCont // DeleteChatControlsConfiguration API operation for QBusiness. // -// Deletes chat controls configured for an existing Amazon Q application. +// Deletes chat controls configured for an existing Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1138,8 +1138,8 @@ func (c *QBusiness) DeleteChatControlsConfigurationRequest(input *DeleteChatCont // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -1147,8 +1147,8 @@ func (c *QBusiness) DeleteChatControlsConfigurationRequest(input *DeleteChatCont // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1220,7 +1220,7 @@ func (c *QBusiness) DeleteConversationRequest(input *DeleteConversationInput) (r // DeleteConversation API operation for QBusiness. // -// Deletes an Amazon Q web experience conversation. +// Deletes an Amazon Q Business web experience conversation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1236,8 +1236,8 @@ func (c *QBusiness) DeleteConversationRequest(input *DeleteConversationInput) (r // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - LicenseNotFoundException @@ -1250,8 +1250,8 @@ func (c *QBusiness) DeleteConversationRequest(input *DeleteConversationInput) (r // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1323,9 +1323,9 @@ func (c *QBusiness) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req * // DeleteDataSource API operation for QBusiness. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1341,8 +1341,8 @@ func (c *QBusiness) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req * // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1354,8 +1354,8 @@ func (c *QBusiness) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req * // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1452,8 +1452,8 @@ func (c *QBusiness) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1465,8 +1465,8 @@ func (c *QBusiness) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1538,7 +1538,7 @@ func (c *QBusiness) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Re // DeleteIndex API operation for QBusiness. // -// Deletes an Amazon Q index. +// Deletes an Amazon Q Business index. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1554,8 +1554,8 @@ func (c *QBusiness) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1567,8 +1567,8 @@ func (c *QBusiness) DeleteIndexRequest(input *DeleteIndexInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1640,7 +1640,7 @@ func (c *QBusiness) DeletePluginRequest(input *DeletePluginInput) (req *request. // DeletePlugin API operation for QBusiness. // -// Deletes an Amazon Q plugin. +// Deletes an Amazon Q Business plugin. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1656,8 +1656,8 @@ func (c *QBusiness) DeletePluginRequest(input *DeletePluginInput) (req *request. // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1669,8 +1669,8 @@ func (c *QBusiness) DeletePluginRequest(input *DeletePluginInput) (req *request. // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1742,7 +1742,7 @@ func (c *QBusiness) DeleteRetrieverRequest(input *DeleteRetrieverInput) (req *re // DeleteRetriever API operation for QBusiness. // -// Deletes the retriever used by an Amazon Q application. +// Deletes the retriever used by an Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1758,8 +1758,8 @@ func (c *QBusiness) DeleteRetrieverRequest(input *DeleteRetrieverInput) (req *re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1771,8 +1771,8 @@ func (c *QBusiness) DeleteRetrieverRequest(input *DeleteRetrieverInput) (req *re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1860,8 +1860,8 @@ func (c *QBusiness) DeleteUserRequest(input *DeleteUserInput) (req *request.Requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1873,8 +1873,8 @@ func (c *QBusiness) DeleteUserRequest(input *DeleteUserInput) (req *request.Requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -1946,7 +1946,7 @@ func (c *QBusiness) DeleteWebExperienceRequest(input *DeleteWebExperienceInput) // DeleteWebExperience API operation for QBusiness. // -// Deletes an Amazon Q web experience. +// Deletes an Amazon Q Business web experience. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1962,8 +1962,8 @@ func (c *QBusiness) DeleteWebExperienceRequest(input *DeleteWebExperienceInput) // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -1975,8 +1975,8 @@ func (c *QBusiness) DeleteWebExperienceRequest(input *DeleteWebExperienceInput) // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2047,7 +2047,7 @@ func (c *QBusiness) GetApplicationRequest(input *GetApplicationInput) (req *requ // GetApplication API operation for QBusiness. // -// Gets information about an existing Amazon Q application. +// Gets information about an existing Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2063,8 +2063,8 @@ func (c *QBusiness) GetApplicationRequest(input *GetApplicationInput) (req *requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2072,8 +2072,8 @@ func (c *QBusiness) GetApplicationRequest(input *GetApplicationInput) (req *requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2151,7 +2151,7 @@ func (c *QBusiness) GetChatControlsConfigurationRequest(input *GetChatControlsCo // GetChatControlsConfiguration API operation for QBusiness. // // Gets information about an chat controls configured for an existing Amazon -// Q application. +// Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2167,8 +2167,8 @@ func (c *QBusiness) GetChatControlsConfigurationRequest(input *GetChatControlsCo // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2176,8 +2176,8 @@ func (c *QBusiness) GetChatControlsConfigurationRequest(input *GetChatControlsCo // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2299,7 +2299,7 @@ func (c *QBusiness) GetDataSourceRequest(input *GetDataSourceInput) (req *reques // GetDataSource API operation for QBusiness. // -// Gets information about an existing Amazon Q data source connector. +// Gets information about an existing Amazon Q Business data source connector. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2315,8 +2315,8 @@ func (c *QBusiness) GetDataSourceRequest(input *GetDataSourceInput) (req *reques // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2324,8 +2324,8 @@ func (c *QBusiness) GetDataSourceRequest(input *GetDataSourceInput) (req *reques // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2412,8 +2412,8 @@ func (c *QBusiness) GetGroupRequest(input *GetGroupInput) (req *request.Request, // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -2425,8 +2425,8 @@ func (c *QBusiness) GetGroupRequest(input *GetGroupInput) (req *request.Request, // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2497,7 +2497,7 @@ func (c *QBusiness) GetIndexRequest(input *GetIndexInput) (req *request.Request, // GetIndex API operation for QBusiness. // -// Gets information about an existing Amazon Q index. +// Gets information about an existing Amazon Q Business index. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2513,8 +2513,8 @@ func (c *QBusiness) GetIndexRequest(input *GetIndexInput) (req *request.Request, // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2522,8 +2522,8 @@ func (c *QBusiness) GetIndexRequest(input *GetIndexInput) (req *request.Request, // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2594,7 +2594,7 @@ func (c *QBusiness) GetPluginRequest(input *GetPluginInput) (req *request.Reques // GetPlugin API operation for QBusiness. // -// Gets information about an existing Amazon Q plugin. +// Gets information about an existing Amazon Q Business plugin. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2610,8 +2610,8 @@ func (c *QBusiness) GetPluginRequest(input *GetPluginInput) (req *request.Reques // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2619,8 +2619,8 @@ func (c *QBusiness) GetPluginRequest(input *GetPluginInput) (req *request.Reques // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2691,7 +2691,8 @@ func (c *QBusiness) GetRetrieverRequest(input *GetRetrieverInput) (req *request. // GetRetriever API operation for QBusiness. // -// Gets information about an existing retriever used by an Amazon Q application. +// Gets information about an existing retriever used by an Amazon Q Business +// application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2707,8 +2708,8 @@ func (c *QBusiness) GetRetrieverRequest(input *GetRetrieverInput) (req *request. // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2716,8 +2717,8 @@ func (c *QBusiness) GetRetrieverRequest(input *GetRetrieverInput) (req *request. // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2805,8 +2806,8 @@ func (c *QBusiness) GetUserRequest(input *GetUserInput) (req *request.Request, o // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -2818,8 +2819,8 @@ func (c *QBusiness) GetUserRequest(input *GetUserInput) (req *request.Request, o // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2890,7 +2891,7 @@ func (c *QBusiness) GetWebExperienceRequest(input *GetWebExperienceInput) (req * // GetWebExperience API operation for QBusiness. // -// Gets information about an existing Amazon Q web experience. +// Gets information about an existing Amazon Q Business web experience. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2906,8 +2907,8 @@ func (c *QBusiness) GetWebExperienceRequest(input *GetWebExperienceInput) (req * // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -2915,8 +2916,8 @@ func (c *QBusiness) GetWebExperienceRequest(input *GetWebExperienceInput) (req * // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -2993,7 +2994,7 @@ func (c *QBusiness) ListApplicationsRequest(input *ListApplicationsInput) (req * // ListApplications API operation for QBusiness. // -// Lists Amazon Q applications. +// Lists Amazon Q Business applications. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3005,8 +3006,8 @@ func (c *QBusiness) ListApplicationsRequest(input *ListApplicationsInput) (req * // Returned Error Types: // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -3014,8 +3015,8 @@ func (c *QBusiness) ListApplicationsRequest(input *ListApplicationsInput) (req * // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3143,7 +3144,7 @@ func (c *QBusiness) ListConversationsRequest(input *ListConversationsInput) (req // ListConversations API operation for QBusiness. // -// Lists one or more Amazon Q conversations. +// Lists one or more Amazon Q Business conversations. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3159,8 +3160,8 @@ func (c *QBusiness) ListConversationsRequest(input *ListConversationsInput) (req // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - LicenseNotFoundException @@ -3173,8 +3174,8 @@ func (c *QBusiness) ListConversationsRequest(input *ListConversationsInput) (req // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3302,7 +3303,7 @@ func (c *QBusiness) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsI // ListDataSourceSyncJobs API operation for QBusiness. // -// Get information about an Amazon Q data source connector synchronization. +// Get information about an Amazon Q Business data source connector synchronization. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3318,8 +3319,8 @@ func (c *QBusiness) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsI // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -3327,8 +3328,8 @@ func (c *QBusiness) ListDataSourceSyncJobsRequest(input *ListDataSourceSyncJobsI // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3456,7 +3457,7 @@ func (c *QBusiness) ListDataSourcesRequest(input *ListDataSourcesInput) (req *re // ListDataSources API operation for QBusiness. // -// Lists the Amazon Q data source connectors that you have created. +// Lists the Amazon Q Business data source connectors that you have created. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3472,8 +3473,8 @@ func (c *QBusiness) ListDataSourcesRequest(input *ListDataSourcesInput) (req *re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -3481,8 +3482,8 @@ func (c *QBusiness) ListDataSourcesRequest(input *ListDataSourcesInput) (req *re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3626,8 +3627,8 @@ func (c *QBusiness) ListDocumentsRequest(input *ListDocumentsInput) (req *reques // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -3635,8 +3636,8 @@ func (c *QBusiness) ListDocumentsRequest(input *ListDocumentsInput) (req *reques // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3780,8 +3781,8 @@ func (c *QBusiness) ListGroupsRequest(input *ListGroupsInput) (req *request.Requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -3793,8 +3794,8 @@ func (c *QBusiness) ListGroupsRequest(input *ListGroupsInput) (req *request.Requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -3922,7 +3923,7 @@ func (c *QBusiness) ListIndicesRequest(input *ListIndicesInput) (req *request.Re // ListIndices API operation for QBusiness. // -// Lists the Amazon Q indices you have created. +// Lists the Amazon Q Business indices you have created. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3938,8 +3939,8 @@ func (c *QBusiness) ListIndicesRequest(input *ListIndicesInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -3947,8 +3948,8 @@ func (c *QBusiness) ListIndicesRequest(input *ListIndicesInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4076,7 +4077,7 @@ func (c *QBusiness) ListMessagesRequest(input *ListMessagesInput) (req *request. // ListMessages API operation for QBusiness. // -// Gets a list of messages associated with an Amazon Q web experience. +// Gets a list of messages associated with an Amazon Q Business web experience. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4092,8 +4093,8 @@ func (c *QBusiness) ListMessagesRequest(input *ListMessagesInput) (req *request. // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - LicenseNotFoundException @@ -4106,8 +4107,8 @@ func (c *QBusiness) ListMessagesRequest(input *ListMessagesInput) (req *request. // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4235,7 +4236,7 @@ func (c *QBusiness) ListPluginsRequest(input *ListPluginsInput) (req *request.Re // ListPlugins API operation for QBusiness. // -// Lists configured Amazon Q plugins. +// Lists configured Amazon Q Business plugins. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4251,8 +4252,8 @@ func (c *QBusiness) ListPluginsRequest(input *ListPluginsInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -4260,8 +4261,8 @@ func (c *QBusiness) ListPluginsRequest(input *ListPluginsInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4389,7 +4390,7 @@ func (c *QBusiness) ListRetrieversRequest(input *ListRetrieversInput) (req *requ // ListRetrievers API operation for QBusiness. // -// Lists the retriever used by an Amazon Q application. +// Lists the retriever used by an Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4405,8 +4406,8 @@ func (c *QBusiness) ListRetrieversRequest(input *ListRetrieversInput) (req *requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -4414,8 +4415,8 @@ func (c *QBusiness) ListRetrieversRequest(input *ListRetrieversInput) (req *requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4537,8 +4538,8 @@ func (c *QBusiness) ListTagsForResourceRequest(input *ListTagsForResourceInput) // ListTagsForResource API operation for QBusiness. // -// Gets a list of tags associated with a specified resource. Amazon Q applications -// and data sources can have tags associated with them. +// Gets a list of tags associated with a specified resource. Amazon Q Business +// applications and data sources can have tags associated with them. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4554,8 +4555,8 @@ func (c *QBusiness) ListTagsForResourceRequest(input *ListTagsForResourceInput) // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -4563,8 +4564,8 @@ func (c *QBusiness) ListTagsForResourceRequest(input *ListTagsForResourceInput) // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4641,7 +4642,7 @@ func (c *QBusiness) ListWebExperiencesRequest(input *ListWebExperiencesInput) (r // ListWebExperiences API operation for QBusiness. // -// Lists one or more Amazon Q Web Experiences. +// Lists one or more Amazon Q Business Web Experiences. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4657,8 +4658,8 @@ func (c *QBusiness) ListWebExperiencesRequest(input *ListWebExperiencesInput) (r // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -4666,8 +4667,8 @@ func (c *QBusiness) ListWebExperiencesRequest(input *ListWebExperiencesInput) (r // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4790,7 +4791,7 @@ func (c *QBusiness) PutFeedbackRequest(input *PutFeedbackInput) (req *request.Re // PutFeedback API operation for QBusiness. // -// Enables your end user to to provide feedback on their Amazon Q generated +// Enables your end user to provide feedback on their Amazon Q Business generated // chat responses. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -4807,8 +4808,8 @@ func (c *QBusiness) PutFeedbackRequest(input *PutFeedbackInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -4816,8 +4817,8 @@ func (c *QBusiness) PutFeedbackRequest(input *PutFeedbackInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -4897,7 +4898,7 @@ func (c *QBusiness) PutGroupRequest(input *PutGroupInput) (req *request.Request, // 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. +// their Amazon Q Business chat results. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4913,8 +4914,8 @@ func (c *QBusiness) PutGroupRequest(input *PutGroupInput) (req *request.Request, // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -4926,15 +4927,15 @@ func (c *QBusiness) PutGroupRequest(input *PutGroupInput) (req *request.Request, // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroup func (c *QBusiness) PutGroup(input *PutGroupInput) (*PutGroupOutput, error) { @@ -5002,7 +5003,7 @@ func (c *QBusiness) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobI // StartDataSourceSyncJob API operation for QBusiness. // // Starts a data source connector synchronization job. If a synchronization -// job is already in progress, Amazon Q returns a ConflictException. +// job is already in progress, Amazon Q Business returns a ConflictException. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5018,8 +5019,8 @@ func (c *QBusiness) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobI // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5031,15 +5032,15 @@ func (c *QBusiness) StartDataSourceSyncJobRequest(input *StartDataSourceSyncJobI // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StartDataSourceSyncJob func (c *QBusiness) StartDataSourceSyncJob(input *StartDataSourceSyncJobInput) (*StartDataSourceSyncJobOutput, error) { @@ -5107,7 +5108,8 @@ func (c *QBusiness) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInp // StopDataSourceSyncJob API operation for QBusiness. // -// Stops an Amazon Q data source connector synchronization job already in progress. +// Stops an Amazon Q Business data source connector synchronization job already +// in progress. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5123,8 +5125,8 @@ func (c *QBusiness) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInp // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -5132,8 +5134,8 @@ func (c *QBusiness) StopDataSourceSyncJobRequest(input *StopDataSourceSyncJobInp // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -5205,9 +5207,9 @@ func (c *QBusiness) TagResourceRequest(input *TagResourceInput) (req *request.Re // TagResource API operation for QBusiness. // -// 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. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5223,8 +5225,8 @@ func (c *QBusiness) TagResourceRequest(input *TagResourceInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5236,8 +5238,8 @@ func (c *QBusiness) TagResourceRequest(input *TagResourceInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -5309,7 +5311,7 @@ func (c *QBusiness) UntagResourceRequest(input *UntagResourceInput) (req *reques // UntagResource API operation for QBusiness. // -// Removes a tag from an Amazon Q application or a data source. +// Removes a tag from an Amazon Q Business application or a data source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5325,8 +5327,8 @@ func (c *QBusiness) UntagResourceRequest(input *UntagResourceInput) (req *reques // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -5334,8 +5336,8 @@ func (c *QBusiness) UntagResourceRequest(input *UntagResourceInput) (req *reques // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -5407,7 +5409,7 @@ func (c *QBusiness) UpdateApplicationRequest(input *UpdateApplicationInput) (req // UpdateApplication API operation for QBusiness. // -// Updates an existing Amazon Q application. +// Updates an existing Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5423,8 +5425,8 @@ func (c *QBusiness) UpdateApplicationRequest(input *UpdateApplicationInput) (req // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5436,8 +5438,8 @@ func (c *QBusiness) UpdateApplicationRequest(input *UpdateApplicationInput) (req // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -5509,7 +5511,8 @@ func (c *QBusiness) UpdateChatControlsConfigurationRequest(input *UpdateChatCont // UpdateChatControlsConfiguration API operation for QBusiness. // -// Updates an set of chat controls configured for an existing Amazon Q application. +// Updates an set of chat controls configured for an existing Amazon Q Business +// application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5525,8 +5528,8 @@ func (c *QBusiness) UpdateChatControlsConfigurationRequest(input *UpdateChatCont // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5538,15 +5541,15 @@ func (c *QBusiness) UpdateChatControlsConfigurationRequest(input *UpdateChatCont // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfiguration func (c *QBusiness) UpdateChatControlsConfiguration(input *UpdateChatControlsConfigurationInput) (*UpdateChatControlsConfigurationOutput, error) { @@ -5614,7 +5617,7 @@ func (c *QBusiness) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req * // UpdateDataSource API operation for QBusiness. // -// Updates an existing Amazon Q data source connector. +// Updates an existing Amazon Q Business data source connector. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5630,8 +5633,8 @@ func (c *QBusiness) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req * // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5643,8 +5646,8 @@ func (c *QBusiness) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req * // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -5716,7 +5719,7 @@ func (c *QBusiness) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Re // UpdateIndex API operation for QBusiness. // -// Updates an Amazon Q index. +// Updates an Amazon Q Business index. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5732,8 +5735,8 @@ func (c *QBusiness) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5745,15 +5748,15 @@ func (c *QBusiness) UpdateIndexRequest(input *UpdateIndexInput) (req *request.Re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateIndex func (c *QBusiness) UpdateIndex(input *UpdateIndexInput) (*UpdateIndexOutput, error) { @@ -5821,7 +5824,7 @@ func (c *QBusiness) UpdatePluginRequest(input *UpdatePluginInput) (req *request. // UpdatePlugin API operation for QBusiness. // -// Updates an Amazon Q plugin. +// Updates an Amazon Q Business plugin. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5837,8 +5840,8 @@ func (c *QBusiness) UpdatePluginRequest(input *UpdatePluginInput) (req *request. // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5850,15 +5853,15 @@ func (c *QBusiness) UpdatePluginRequest(input *UpdatePluginInput) (req *request. // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdatePlugin func (c *QBusiness) UpdatePlugin(input *UpdatePluginInput) (*UpdatePluginOutput, error) { @@ -5926,7 +5929,7 @@ func (c *QBusiness) UpdateRetrieverRequest(input *UpdateRetrieverInput) (req *re // UpdateRetriever API operation for QBusiness. // -// Updates the retriever used for your Amazon Q application. +// Updates the retriever used for your Amazon Q Business application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5942,8 +5945,8 @@ func (c *QBusiness) UpdateRetrieverRequest(input *UpdateRetrieverInput) (req *re // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -5955,15 +5958,15 @@ func (c *QBusiness) UpdateRetrieverRequest(input *UpdateRetrieverInput) (req *re // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateRetriever func (c *QBusiness) UpdateRetriever(input *UpdateRetrieverInput) (*UpdateRetrieverOutput, error) { @@ -6046,8 +6049,8 @@ func (c *QBusiness) UpdateUserRequest(input *UpdateUserInput) (req *request.Requ // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ThrottlingException @@ -6055,15 +6058,15 @@ func (c *QBusiness) UpdateUserRequest(input *UpdateUserInput) (req *request.Requ // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required // permission policies and user accounts and try again. // // - ServiceQuotaExceededException -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateUser func (c *QBusiness) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error) { @@ -6131,7 +6134,7 @@ func (c *QBusiness) UpdateWebExperienceRequest(input *UpdateWebExperienceInput) // UpdateWebExperience API operation for QBusiness. // -// Updates an Amazon Q web experience. +// Updates an Amazon Q Business web experience. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6147,8 +6150,8 @@ func (c *QBusiness) UpdateWebExperienceRequest(input *UpdateWebExperienceInput) // the correct resource and try again. // // - InternalServerException -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. // // - ConflictException @@ -6160,8 +6163,8 @@ func (c *QBusiness) UpdateWebExperienceRequest(input *UpdateWebExperienceInput) // try again. // // - ValidationException -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. // // - AccessDeniedException // You don't have access to perform this action. Make sure you have the required @@ -6389,15 +6392,15 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// 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 +// 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. +// pre-populated by Amazon Q Business. type ActionReview struct { _ struct{} `type:"structure"` - // Field values that an end user needs to provide to Amazon Q for Amazon Q to - // perform the requested plugin action. + // Field values that an end user needs to provide to Amazon Q Business for Amazon + // Q Business to perform the requested plugin action. Payload map[string]*ActionReviewPayloadField `locationName:"payload" type:"map"` // A string used to retain information about the hierarchical contexts within @@ -6458,7 +6461,7 @@ type ActionReviewPayloadField struct { _ struct{} `type:"structure"` // 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. + // Amazon Q Business for Amazon Q Business to perform the requested plugin action. AllowedValues []*ActionReviewPayloadFieldAllowedValue `locationName:"allowedValues" type:"list"` // The name of the field. @@ -6523,7 +6526,7 @@ func (s *ActionReviewPayloadField) SetType(v string) *ActionReviewPayloadField { } // 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. +// Amazon Q Business for Amazon Q Business to perform the requested plugin action. type ActionReviewPayloadFieldAllowedValue struct { _ struct{} `type:"structure"` } @@ -6546,24 +6549,24 @@ func (s ActionReviewPayloadFieldAllowedValue) GoString() string { return s.String() } -// Summary information for an Amazon Q application. +// Summary information for an Amazon Q Business application. type Application struct { _ struct{} `type:"structure"` - // The identifier for the Amazon Q application. + // The identifier for the Amazon Q Business application. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` - // The Unix timestamp when the Amazon Q application was created. + // The Unix timestamp when the Amazon Q Business application was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The name of the Amazon Q application. + // The name of the Amazon Q Business application. DisplayName *string `locationName:"displayName" min:"1" type:"string"` - // 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. Status *string `locationName:"status" type:"string" enum:"ApplicationStatus"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -6649,6 +6652,46 @@ func (s *AppliedAttachmentsConfiguration) SetAttachmentsControlMode(v string) *A return s } +// 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 (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) +// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope). +type AppliedCreatorModeConfiguration struct { + _ struct{} `type:"structure"` + + // Information about whether creator mode is enabled or disabled for an Amazon + // Q Business application. + // + // CreatorModeControl is a required field + CreatorModeControl *string `locationName:"creatorModeControl" type:"string" required:"true" enum:"CreatorModeControl"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppliedCreatorModeConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AppliedCreatorModeConfiguration) GoString() string { + return s.String() +} + +// SetCreatorModeControl sets the CreatorModeControl field's value. +func (s *AppliedCreatorModeConfiguration) SetCreatorModeControl(v string) *AppliedCreatorModeConfiguration { + s.CreatorModeControl = &v + return s +} + // A file directly uploaded into a web experience chat. type AttachmentInput_ struct { _ struct{} `type:"structure"` @@ -6820,30 +6863,41 @@ type AttributeFilter struct { AndAllFilters []*AttributeFilter `locationName:"andAllFilters" type:"list"` // Returns true when a document contains all the specified document attributes - // or metadata fields. + // or metadata fields. Supported for the following document attribute value + // types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // stringListValue. ContainsAll *DocumentAttribute `locationName:"containsAll" type:"structure"` // Returns true when a document contains any of the specified document attributes - // or metadata fields. + // or metadata fields. Supported for the following document attribute value + // types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue, longValue, stringListValue and stringValue. ContainsAny *DocumentAttribute `locationName:"containsAny" type:"structure"` // Performs an equals operation on two document attributes or metadata fields. + // Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue, longValue, stringListValue and stringValue. EqualsTo *DocumentAttribute `locationName:"equalsTo" type:"structure"` // Performs a greater than operation on two document attributes or metadata - // fields. Use with a document attribute of type Date or Long. + // fields. Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue and longValue. GreaterThan *DocumentAttribute `locationName:"greaterThan" type:"structure"` // Performs a greater or equals than operation on two document attributes or - // metadata fields. Use with a document attribute of type Date or Long. + // metadata fields. Supported for the following document attribute value types + // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue and longValue. GreaterThanOrEquals *DocumentAttribute `locationName:"greaterThanOrEquals" type:"structure"` // Performs a less than operation on two document attributes or metadata fields. - // Use with a document attribute of type Date or Long. + // Supported for the following document attribute value types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue and longValue. LessThan *DocumentAttribute `locationName:"lessThan" type:"structure"` // Performs a less than or equals operation on two document attributes or metadata - // fields. Use with a document attribute of type Date or Long. + // fields.Supported for the following document attribute value type (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html): + // dateValue and longValue. LessThanOrEquals *DocumentAttribute `locationName:"lessThanOrEquals" type:"structure"` // Performs a logical NOT operation on all supplied filters. @@ -6996,7 +7050,7 @@ func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter type BasicAuthConfiguration struct { _ struct{} `type:"structure"` - // The ARN of an IAM role used by Amazon Q to access the basic authentication + // The ARN of an IAM role used by Amazon Q Business to access the basic authentication // credentials stored in a Secrets Manager secret. // // RoleArn is a required field @@ -7058,7 +7112,7 @@ func (s *BasicAuthConfiguration) SetSecretArn(v string) *BasicAuthConfiguration type BatchDeleteDocumentInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -7066,12 +7120,13 @@ type BatchDeleteDocumentInput struct { // The identifier of the data source sync during which the documents were deleted. DataSourceSyncId *string `locationName:"dataSourceSyncId" min:"36" type:"string"` - // Documents deleted from the Amazon Q index. + // Documents deleted from the Amazon Q Business index. // // Documents is a required field Documents []*DeleteDocument `locationName:"documents" type:"list" required:"true"` - // The identifier of the Amazon Q index that contains the documents to delete. + // The identifier of the Amazon Q Business index that contains the documents + // to delete. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -7160,8 +7215,8 @@ func (s *BatchDeleteDocumentInput) SetIndexId(v string) *BatchDeleteDocumentInpu type BatchDeleteDocumentOutput struct { _ struct{} `type:"structure"` - // 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 + // 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. FailedDocuments []*FailedDocument `locationName:"failedDocuments" type:"list"` } @@ -7193,7 +7248,7 @@ func (s *BatchDeleteDocumentOutput) SetFailedDocuments(v []*FailedDocument) *Bat type BatchPutDocumentInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -7206,7 +7261,7 @@ type BatchPutDocumentInput struct { // Documents is a required field Documents []*Document `locationName:"documents" min:"1" type:"list" required:"true"` - // The identifier of the Amazon Q index to add the documents to. + // The identifier of the Amazon Q Business index to add the documents to. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -7308,8 +7363,8 @@ func (s *BatchPutDocumentInput) SetRoleArn(v string) *BatchPutDocumentInput { type BatchPutDocumentOutput struct { _ struct{} `type:"structure"` - // 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 + // 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. FailedDocuments []*FailedDocument `locationName:"failedDocuments" type:"list"` } @@ -7343,7 +7398,7 @@ func (s *BatchPutDocumentOutput) SetFailedDocuments(v []*FailedDocument) *BatchP type BlockedPhrasesConfiguration struct { _ struct{} `type:"structure"` - // A list of phrases blocked from a Amazon Q web experience chat. + // A list of phrases blocked from a Amazon Q Business web experience chat. BlockedPhrases []*string `locationName:"blockedPhrases" type:"list"` // The configured custom message displayed to an end user informing them that @@ -7381,14 +7436,15 @@ func (s *BlockedPhrasesConfiguration) SetSystemMessageOverride(v string) *Blocke return s } -// Updates a blocked phrases configuration in your Amazon Q application. +// Updates a blocked phrases configuration in your Amazon Q Business application. type BlockedPhrasesConfigurationUpdate struct { _ struct{} `type:"structure"` - // Creates or updates a blocked phrases configuration in your Amazon Q application. + // Creates or updates a blocked phrases configuration in your Amazon Q Business + // application. BlockedPhrasesToCreateOrUpdate []*string `locationName:"blockedPhrasesToCreateOrUpdate" type:"list"` - // Deletes a blocked phrases configuration in your Amazon Q application. + // Deletes a blocked phrases configuration in your Amazon Q Business application. BlockedPhrasesToDelete []*string `locationName:"blockedPhrasesToDelete" type:"list"` // The configured custom message displayed to your end user when they use blocked @@ -7432,10 +7488,61 @@ func (s *BlockedPhrasesConfigurationUpdate) SetSystemMessageOverride(v string) * return s } +// Configuration information for Amazon Q Business conversation modes. +// +// For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) +// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope). +type ChatModeConfiguration struct { + _ struct{} `type:"structure"` + + // Configuration information required to invoke chat in PLUGIN_MODE. + PluginConfiguration *PluginConfiguration `locationName:"pluginConfiguration" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChatModeConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ChatModeConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ChatModeConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ChatModeConfiguration"} + if s.PluginConfiguration != nil { + if err := s.PluginConfiguration.Validate(); err != nil { + invalidParams.AddNested("PluginConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPluginConfiguration sets the PluginConfiguration field's value. +func (s *ChatModeConfiguration) SetPluginConfiguration(v *PluginConfiguration) *ChatModeConfiguration { + s.PluginConfiguration = v + return s +} + type ChatSyncInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application linked to the Amazon Q conversation. + // The identifier of the Amazon Q Business application linked to the Amazon + // Q Business conversation. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -7444,14 +7551,35 @@ type ChatSyncInput struct { // 5 files of upto 10 MB each. Attachments []*AttachmentInput_ `locationName:"attachments" min:"1" type:"list"` - // Enables filtering of Amazon Q web experience responses based on document - // attributes or metadata fields. + // Enables filtering of Amazon Q Business web experience responses based on + // document attributes or metadata fields. AttributeFilter *AttributeFilter `locationName:"attributeFilter" type:"structure"` + // 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 (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html), + // Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html), + // and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope). + ChatMode *string `locationName:"chatMode" type:"string" enum:"ChatMode"` + + // The chat mode configuration for an Amazon Q Business application. + ChatModeConfiguration *ChatModeConfiguration `locationName:"chatModeConfiguration" type:"structure"` + // A token that you provide to identify a chat request. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The identifier of the Amazon Q conversation. + // The identifier of the Amazon Q Business conversation. ConversationId *string `locationName:"conversationId" min:"36" type:"string"` // The identifier of the previous end user text input message in a conversation. @@ -7461,9 +7589,7 @@ type ChatSyncInput struct { UserGroups []*string `location:"querystring" locationName:"userGroups" type:"list"` // The identifier of the user attached to the chat input. - // - // UserId is a required field - UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string" required:"true"` + UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"` // A end user message in a conversation. UserMessage *string `locationName:"userMessage" min:"1" type:"string"` @@ -7508,9 +7634,6 @@ func (s *ChatSyncInput) Validate() error { if s.ParentMessageId != nil && len(*s.ParentMessageId) < 36 { invalidParams.Add(request.NewErrParamMinLen("ParentMessageId", 36)) } - if s.UserId == nil { - invalidParams.Add(request.NewErrParamRequired("UserId")) - } if s.UserId != nil && len(*s.UserId) < 1 { invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } @@ -7532,6 +7655,11 @@ func (s *ChatSyncInput) Validate() error { invalidParams.AddNested("AttributeFilter", err.(request.ErrInvalidParams)) } } + if s.ChatModeConfiguration != nil { + if err := s.ChatModeConfiguration.Validate(); err != nil { + invalidParams.AddNested("ChatModeConfiguration", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -7557,6 +7685,18 @@ func (s *ChatSyncInput) SetAttributeFilter(v *AttributeFilter) *ChatSyncInput { return s } +// SetChatMode sets the ChatMode field's value. +func (s *ChatSyncInput) SetChatMode(v string) *ChatSyncInput { + s.ChatMode = &v + return s +} + +// SetChatModeConfiguration sets the ChatModeConfiguration field's value. +func (s *ChatSyncInput) SetChatModeConfiguration(v *ChatModeConfiguration) *ChatSyncInput { + s.ChatModeConfiguration = v + return s +} + // SetClientToken sets the ClientToken field's value. func (s *ChatSyncInput) SetClientToken(v string) *ChatSyncInput { s.ClientToken = &v @@ -7596,11 +7736,11 @@ func (s *ChatSyncInput) SetUserMessage(v string) *ChatSyncInput { type ChatSyncOutput struct { _ struct{} `type:"structure"` - // A request from Amazon Q to the end user for information Amazon Q needs to - // successfully complete a requested plugin action. + // A request from Amazon Q Business to the end user for information Amazon Q + // Business needs to successfully complete a requested plugin action. ActionReview *ActionReview `locationName:"actionReview" type:"structure"` - // The identifier of the Amazon Q conversation. + // The identifier of the Amazon Q Business conversation. ConversationId *string `locationName:"conversationId" min:"36" type:"string"` // A list of files which failed to upload during chat. @@ -7612,10 +7752,11 @@ type ChatSyncOutput struct { // An AI-generated message in a conversation. SystemMessage *string `locationName:"systemMessage" min:"1" type:"string"` - // The identifier of an Amazon Q AI generated message within the conversation. + // The identifier of an Amazon Q Business AI generated message within the conversation. SystemMessageId *string `locationName:"systemMessageId" min:"36" type:"string"` - // The identifier of an Amazon Q end user text input message within the conversation. + // The identifier of an Amazon Q Business end user text input message within + // the conversation. UserMessageId *string `locationName:"userMessageId" min:"36" type:"string"` } @@ -7755,10 +7896,10 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } -// 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. +// 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. type ContentBlockerRule struct { _ struct{} `type:"structure"` @@ -7791,12 +7932,13 @@ func (s *ContentBlockerRule) SetSystemMessageOverride(v string) *ContentBlockerR return s } -// Rules for retrieving content from data sources connected to a Amazon Q application -// for a specific topic control configuration. +// Rules for retrieving content from data sources connected to a Amazon Q Business +// application for a specific topic control configuration. type ContentRetrievalRule struct { _ struct{} `type:"structure"` - // Specifies data sources in a Amazon Q application to use for content generation. + // Specifies data sources in a Amazon Q Business application to use for content + // generation. EligibleDataSources []*EligibleDataSource `locationName:"eligibleDataSources" type:"list"` } @@ -7844,11 +7986,11 @@ func (s *ContentRetrievalRule) SetEligibleDataSources(v []*EligibleDataSource) * return s } -// A conversation in an Amazon Q application. +// A conversation in an Amazon Q Business application. type Conversation struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q conversation. + // The identifier of the Amazon Q Business conversation. ConversationId *string `locationName:"conversationId" min:"36" type:"string"` // The start time of the conversation. @@ -7901,31 +8043,35 @@ type CreateApplicationInput struct { AttachmentsConfiguration *AttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"` // A token that you provide to identify the request to create your Amazon Q - // application. + // Business application. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // A description for the Amazon Q application. + // A description for the Amazon Q Business application. Description *string `locationName:"description" type:"string"` - // A name for the Amazon Q application. + // A name for the Amazon Q Business application. // // DisplayName is a required field DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"` // The identifier of the KMS key that is used to encrypt your data. Amazon Q - // doesn't support asymmetric keys. + // Business doesn't support asymmetric keys. EncryptionConfiguration *EncryptionConfiguration `locationName:"encryptionConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of the IAM Identity Center instance you are + // either creating for—or connecting to—your Amazon Q Business application. + IdentityCenterInstanceArn *string `locationName:"identityCenterInstanceArn" min:"10" type:"string"` + // The Amazon Resource Name (ARN) of an IAM role with permissions to access // your Amazon CloudWatch logs and metrics. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // 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: _ . : / = + - @. + // 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: _ . : / = + - @. Tags []*Tag `locationName:"tags" type:"list"` } @@ -7959,6 +8105,9 @@ func (s *CreateApplicationInput) Validate() error { if s.DisplayName != nil && len(*s.DisplayName) < 1 { invalidParams.Add(request.NewErrParamMinLen("DisplayName", 1)) } + if s.IdentityCenterInstanceArn != nil && len(*s.IdentityCenterInstanceArn) < 10 { + invalidParams.Add(request.NewErrParamMinLen("IdentityCenterInstanceArn", 10)) + } if s.RoleArn == nil { invalidParams.Add(request.NewErrParamRequired("RoleArn")) } @@ -8019,6 +8168,12 @@ func (s *CreateApplicationInput) SetEncryptionConfiguration(v *EncryptionConfigu return s } +// SetIdentityCenterInstanceArn sets the IdentityCenterInstanceArn field's value. +func (s *CreateApplicationInput) SetIdentityCenterInstanceArn(v string) *CreateApplicationInput { + s.IdentityCenterInstanceArn = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CreateApplicationInput) SetRoleArn(v string) *CreateApplicationInput { s.RoleArn = &v @@ -8034,10 +8189,10 @@ func (s *CreateApplicationInput) SetTags(v []*Tag) *CreateApplicationInput { type CreateApplicationOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Q application. + // The Amazon Resource Name (ARN) of the Amazon Q Business application. ApplicationArn *string `locationName:"applicationArn" type:"string"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` } @@ -8074,7 +8229,7 @@ func (s *CreateApplicationOutput) SetApplicationId(v string) *CreateApplicationO type CreateIndexInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application using the index. + // The identifier of the Amazon Q Business application using the index. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -8088,10 +8243,10 @@ type CreateIndexInput struct { // one index. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // A description for the Amazon Q index. + // A description for the Amazon Q Business index. Description *string `locationName:"description" type:"string"` - // A name for the Amazon Q index. + // A name for the Amazon Q Business index. // // DisplayName is a required field DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"` @@ -8200,10 +8355,10 @@ func (s *CreateIndexInput) SetTags(v []*Tag) *CreateIndexInput { type CreateIndexOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of an Amazon Q index. + // The Amazon Resource Name (ARN) of an Amazon Q Business index. IndexArn *string `locationName:"indexArn" type:"string"` - // The identifier for the Amazon Q index. + // The identifier for the Amazon Q Business index. IndexId *string `locationName:"indexId" min:"36" type:"string"` } @@ -8245,13 +8400,13 @@ type CreatePluginInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // Authentication configuration information for an Amazon Q plugin. + // Authentication configuration information for an Amazon Q Business plugin. // // AuthConfiguration is a required field AuthConfiguration *PluginAuthConfiguration `locationName:"authConfiguration" type:"structure" required:"true"` // A token that you provide to identify the request to create your Amazon Q - // plugin. + // Business plugin. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // A the name for your plugin. @@ -8431,17 +8586,17 @@ func (s *CreatePluginOutput) SetPluginId(v string) *CreatePluginOutput { type CreateRetrieverInput struct { _ struct{} `type:"structure"` - // The identifier of your Amazon Q application. + // The identifier of your Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` // A token that you provide to identify the request to create your Amazon Q - // application retriever. + // Business application retriever. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // Provides information on how the retriever used for your Amazon Q application - // is configured. + // Provides information on how the retriever used for your Amazon Q Business + // application is configured. // // Configuration is a required field Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure" required:"true"` @@ -8451,7 +8606,7 @@ type CreateRetrieverInput struct { // DisplayName is a required field DisplayName *string `locationName:"displayName" min:"1" type:"string" required:"true"` - // The ARN of an IAM role used by Amazon Q to access the basic authentication + // The ARN of an IAM role used by Amazon Q Business to access the basic authentication // credentials stored in a Secrets Manager secret. RoleArn *string `locationName:"roleArn" type:"string"` @@ -8622,7 +8777,7 @@ type CreateUserInput struct { ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` // A token that you provide to identify the request to create your Amazon Q - // user mapping. + // Business user mapping. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The list of user aliases in the mapping. @@ -8736,31 +8891,36 @@ func (s CreateUserOutput) GoString() string { type CreateWebExperienceInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q web experience. + // The identifier of the Amazon Q Business web experience. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // A token you provide to identify a request to create an Amazon Q web experience. + // A token you provide to identify a request to create an Amazon Q Business + // web experience. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + // The Amazon Resource Name (ARN) of the service role attached to your web experience. + RoleArn *string `locationName:"roleArn" type:"string"` + // Determines whether sample prompts are enabled in the web experience for an // end user. SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"` - // A subtitle to personalize your Amazon Q web experience. + // A subtitle to personalize your Amazon Q Business web experience. Subtitle *string `locationName:"subtitle" type:"string"` - // 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: _ . : / = + - @. + // 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: _ . : / = + - @. Tags []*Tag `locationName:"tags" type:"list"` - // The title for your Amazon Q web experience. + // The title for your Amazon Q Business web experience. Title *string `locationName:"title" type:"string"` - // The customized welcome message for end users of an Amazon Q web experience. + // The customized welcome message for end users of an Amazon Q Business web + // experience. WelcomeMessage *string `locationName:"welcomeMessage" type:"string"` } @@ -8823,6 +8983,12 @@ func (s *CreateWebExperienceInput) SetClientToken(v string) *CreateWebExperience return s } +// SetRoleArn sets the RoleArn field's value. +func (s *CreateWebExperienceInput) SetRoleArn(v string) *CreateWebExperienceInput { + s.RoleArn = &v + return s +} + // SetSamplePromptsControlMode sets the SamplePromptsControlMode field's value. func (s *CreateWebExperienceInput) SetSamplePromptsControlMode(v string) *CreateWebExperienceInput { s.SamplePromptsControlMode = &v @@ -8856,10 +9022,10 @@ func (s *CreateWebExperienceInput) SetWelcomeMessage(v string) *CreateWebExperie type CreateWebExperienceOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of an Amazon Q web experience. + // The Amazon Resource Name (ARN) of an Amazon Q Business web experience. WebExperienceArn *string `locationName:"webExperienceArn" type:"string"` - // The identifier of the Amazon Q web experience. + // The identifier of the Amazon Q Business web experience. WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"` } @@ -8893,26 +9059,77 @@ func (s *CreateWebExperienceOutput) SetWebExperienceId(v string) *CreateWebExper return s } -// A data source in an Amazon Q application. +// Configuration information required to invoke chat in CREATOR_MODE. +// +// For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html) +// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope). +type CreatorModeConfiguration struct { + _ struct{} `type:"structure"` + + // Status information about whether CREATOR_MODE has been enabled or disabled. + // The default status is DISABLED. + // + // CreatorModeControl is a required field + CreatorModeControl *string `locationName:"creatorModeControl" type:"string" required:"true" enum:"CreatorModeControl"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatorModeConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatorModeConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatorModeConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatorModeConfiguration"} + if s.CreatorModeControl == nil { + invalidParams.Add(request.NewErrParamRequired("CreatorModeControl")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreatorModeControl sets the CreatorModeControl field's value. +func (s *CreatorModeConfiguration) SetCreatorModeControl(v string) *CreatorModeConfiguration { + s.CreatorModeControl = &v + return s +} + +// A data source in an Amazon Q Business application. type DataSource struct { _ struct{} `type:"structure"` - // The Unix timestamp when the Amazon Q data source was created. + // The Unix timestamp when the Amazon Q Business data source was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The identifier of the Amazon Q data source. + // The identifier of the Amazon Q Business data source. DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"` - // The name of the Amazon Q data source. + // The name of the Amazon Q Business data source. DisplayName *string `locationName:"displayName" min:"1" type:"string"` - // The status of the Amazon Q data source. + // The status of the Amazon Q Business data source. Status *string `locationName:"status" type:"string" enum:"DataSourceStatus"` - // The type of the Amazon Q data source. + // The type of the Amazon Q Business data source. Type *string `locationName:"type" min:"1" type:"string"` - // The Unix timestamp when the Amazon Q data source was last updated. + // The Unix timestamp when the Amazon Q Business data source was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -8970,7 +9187,7 @@ func (s *DataSource) SetUpdatedAt(v time.Time) *DataSource { return s } -// Provides information about an Amazon Q data source connector synchronization +// Provides information about an Amazon Q Business data source connector synchronization // job. type DataSourceSyncJob struct { _ struct{} `type:"structure"` @@ -9063,8 +9280,8 @@ func (s *DataSourceSyncJob) SetStatus(v string) *DataSourceSyncJob { return s } -// Maps a batch delete document request to a specific Amazon Q data source connector -// sync job. +// Maps a batch delete document request to a specific Amazon Q Business data +// source connector sync job. type DataSourceSyncJobMetrics struct { _ struct{} `type:"structure"` @@ -9143,7 +9360,7 @@ type DataSourceVpcConfiguration struct { _ struct{} `type:"structure"` // A list of identifiers of security groups within your Amazon VPC. The security - // groups should enable Amazon Q to connect to the data source. + // groups should enable Amazon Q Business to connect to the data source. // // SecurityGroupIds is a required field SecurityGroupIds []*string `locationName:"securityGroupIds" min:"1" type:"list" required:"true"` @@ -9207,8 +9424,8 @@ func (s *DataSourceVpcConfiguration) SetSubnetIds(v []*string) *DataSourceVpcCon // 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). +// For more information on how boosting document attributes work in Amazon Q +// Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). type DateAttributeBoostingConfiguration struct { _ struct{} `type:"structure"` @@ -9268,7 +9485,7 @@ func (s *DateAttributeBoostingConfiguration) SetBoostingLevel(v string) *DateAtt type DeleteApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -9411,20 +9628,19 @@ func (s DeleteChatControlsConfigurationOutput) GoString() string { type DeleteConversationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application associated with the conversation. + // The identifier of the Amazon Q Business application associated with the conversation. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q web experience conversation being deleted. + // The identifier of the Amazon Q Business web experience conversation being + // deleted. // // ConversationId is a required field ConversationId *string `location:"uri" locationName:"conversationId" min:"36" type:"string" required:"true"` // The identifier of the user who is deleting the conversation. - // - // UserId is a required field - UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string" required:"true"` + UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -9460,9 +9676,6 @@ func (s *DeleteConversationInput) Validate() error { if s.ConversationId != nil && len(*s.ConversationId) < 36 { invalidParams.Add(request.NewErrParamMinLen("ConversationId", 36)) } - if s.UserId == nil { - invalidParams.Add(request.NewErrParamRequired("UserId")) - } if s.UserId != nil && len(*s.UserId) < 1 { invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } @@ -9516,7 +9729,8 @@ func (s DeleteConversationOutput) GoString() string { type DeleteDataSourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application used with the data source connector. + // The identifier of the Amazon Q Business application used with the data source + // connector. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -9618,7 +9832,7 @@ func (s DeleteDataSourceOutput) GoString() string { return s.String() } -// A document deleted from an Amazon Q data source connector. +// A document deleted from an Amazon Q Business data source connector. type DeleteDocument struct { _ struct{} `type:"structure"` @@ -9796,12 +10010,13 @@ func (s DeleteGroupOutput) GoString() string { type DeleteIndexInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application the Amazon Q index is linked to. + // The identifier of the Amazon Q Business application the Amazon Q Business + // index is linked to. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q index. + // The identifier of the Amazon Q Business index. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -9884,7 +10099,7 @@ func (s DeleteIndexOutput) GoString() string { type DeletePluginInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier the application attached to the Amazon Q plugin. + // The identifier the application attached to the Amazon Q Business plugin. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -9972,7 +10187,7 @@ func (s DeletePluginOutput) GoString() string { type DeleteRetrieverInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application using the retriever. + // The identifier of the Amazon Q Business application using the retriever. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -10148,12 +10363,13 @@ func (s DeleteUserOutput) GoString() string { type DeleteWebExperienceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application linked to the Amazon Q web experience. + // The identifier of the Amazon Q Business application linked to the Amazon + // Q Business web experience. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q web experience being deleted. + // The identifier of the Amazon Q Business web experience being deleted. // // WebExperienceId is a required field WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"` @@ -10233,15 +10449,15 @@ func (s DeleteWebExperienceOutput) GoString() string { return s.String() } -// A document in an Amazon Q application. +// A document in an Amazon Q Business application. type Document struct { _ struct{} `type:"structure"` // Configuration information for access permission to a document. AccessConfiguration *AccessConfiguration `locationName:"accessConfiguration" type:"structure"` - // Custom attributes to apply to the document for refining Amazon Q web experience - // responses. + // Custom attributes to apply to the document for refining Amazon Q Business + // web experience responses. Attributes []*DocumentAttribute `locationName:"attributes" min:"1" type:"list"` // The contents of the document. @@ -10438,10 +10654,10 @@ func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribu return s } -// 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. +// 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 @@ -10450,8 +10666,8 @@ func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribu // 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). +// For more information on how boosting document attributes work in Amazon Q +// Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). type DocumentAttributeBoostingConfiguration struct { _ struct{} `type:"structure"` @@ -10541,7 +10757,7 @@ func (s *DocumentAttributeBoostingConfiguration) SetStringListConfiguration(v *S } // The condition used for the target document attribute or metadata field when -// ingesting documents into Amazon Q. You use this with DocumentAttributeTarget +// ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) // to apply the condition. // @@ -10551,10 +10767,10 @@ func (s *DocumentAttributeBoostingConfiguration) SetStringListConfiguration(v *S // '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. +// 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. type DocumentAttributeCondition struct { _ struct{} `type:"structure"` @@ -10563,8 +10779,8 @@ type DocumentAttributeCondition struct { // 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. + // Amazon Q Business currently doesn't support _document_body as an attribute + // key used for the condition. // // Key is a required field Key *string `locationName:"key" min:"1" type:"string" required:"true"` @@ -10709,7 +10925,7 @@ func (s *DocumentAttributeConfiguration) SetType(v string) *DocumentAttributeCon } // The target document attribute or metadata field you want to alter when ingesting -// documents into Amazon Q. +// 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' @@ -10717,11 +10933,11 @@ func (s *DocumentAttributeConfiguration) SetType(v string) *DocumentAttributeCon // 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). -// Amazon Q will then map your newly created document attribute to your index -// field. +// 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). +// Amazon Q Business will then map your newly created document attribute to +// your index field. // // You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html). type DocumentAttributeTarget struct { @@ -10866,9 +11082,9 @@ type DocumentContent struct { // 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. + // 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. // Blob is automatically base64 encoded/decoded by the SDK. Blob []byte `locationName:"blob" type:"blob"` @@ -10921,7 +11137,7 @@ func (s *DocumentContent) SetS3(v *S3) *DocumentContent { return s } -// The details of a document within an Amazon Q index. +// The details of a document within an Amazon Q Business index. type DocumentDetails struct { _ struct{} `type:"structure"` @@ -10997,19 +11213,19 @@ type DocumentEnrichmentConfiguration struct { _ struct{} `type:"structure"` // Configuration information to alter document attributes or metadata fields - // and content when ingesting documents into Amazon Q. + // and content when ingesting documents into Amazon Q Business. InlineConfigurations []*InlineDocumentEnrichmentConfiguration `locationName:"inlineConfigurations" min:"1" type:"list"` // Provides the configuration information for invoking a Lambda function in // Lambda to alter document metadata and content when ingesting documents into - // Amazon Q. + // Amazon Q Business. // // You can configure your Lambda function using PreExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html) // 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 + // If you want to apply advanced alterations on the Amazon Q Business structured + // documents, you must configure your Lambda function using PostExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html). // // You can only invoke one Lambda function. However, this function can invoke @@ -11020,14 +11236,14 @@ type DocumentEnrichmentConfiguration struct { // Provides the configuration information for invoking a Lambda function in // Lambda to alter document metadata and content when ingesting documents into - // Amazon Q. + // Amazon Q Business. // // You can configure your Lambda function using PreExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html) // 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 + // If you want to apply advanced alterations on the Amazon Q Business structured + // documents, you must configure your Lambda function using PostExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html). // // You can only invoke one Lambda function. However, this function can invoke @@ -11106,7 +11322,8 @@ func (s *DocumentEnrichmentConfiguration) SetPreExtractionHookConfiguration(v *H return s } -// The identifier of the data source Amazon Q will generate responses from. +// The identifier of the data source Amazon Q Business will generate responses +// from. type EligibleDataSource struct { _ struct{} `type:"structure"` @@ -11164,11 +11381,12 @@ func (s *EligibleDataSource) SetIndexId(v string) *EligibleDataSource { } // Provides the identifier of the KMS key used to encrypt data indexed by Amazon -// Q. Amazon Q doesn't support asymmetric keys. +// Q Business. Amazon Q Business doesn't support asymmetric keys. type EncryptionConfiguration struct { _ struct{} `type:"structure"` - // The identifier of the KMS key. Amazon Q doesn't support asymmetric keys. + // The identifier of the KMS key. Amazon Q Business doesn't support asymmetric + // keys. // // KmsKeyId is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by EncryptionConfiguration's @@ -11254,21 +11472,21 @@ func (s *ErrorDetail) SetErrorMessage(v string) *ErrorDetail { return s } -// 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 +// 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. type FailedDocument struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q data source connector that contains the failed - // document. + // The identifier of the Amazon Q Business data source connector that contains + // the failed document. DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"` // An explanation for why the document couldn't be removed from the index. Error *ErrorDetail `locationName:"error" type:"structure"` // The identifier of the document that couldn't be removed from the Amazon Q - // index. + // Business index. Id *string `locationName:"id" min:"1" type:"string"` } @@ -11311,7 +11529,7 @@ func (s *FailedDocument) SetId(v string) *FailedDocument { type GetApplicationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -11360,40 +11578,44 @@ func (s *GetApplicationInput) SetApplicationId(v string) *GetApplicationInput { type GetApplicationOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Q application. + // The Amazon Resource Name (ARN) of the Amazon Q Business application. ApplicationArn *string `locationName:"applicationArn" type:"string"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` // Settings for whether end users can upload files directly during chat. AttachmentsConfiguration *AppliedAttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // A description for the Amazon Q application. + // A description for the Amazon Q Business application. Description *string `locationName:"description" type:"string"` - // The name of the Amazon Q application. + // The name of the Amazon Q Business application. DisplayName *string `locationName:"displayName" min:"1" type:"string"` // The identifier of the Amazon Web Services KMS key that is used to encrypt - // your data. Amazon Q doesn't support asymmetric keys. + // your data. Amazon Q Business doesn't support asymmetric keys. EncryptionConfiguration *EncryptionConfiguration `locationName:"encryptionConfiguration" type:"structure"` // If the Status field is set to ERROR, the ErrorMessage field contains a description // of the error that caused the synchronization to fail. Error *ErrorDetail `locationName:"error" type:"structure"` + // The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached + // to your Amazon Q Business application. + IdentityCenterApplicationArn *string `locationName:"identityCenterApplicationArn" min:"10" type:"string"` + // The Amazon Resource Name (ARN) of the IAM with permissions to access your // CloudWatch logs and metrics. RoleArn *string `locationName:"roleArn" type:"string"` - // The status of the Amazon Q application. + // The status of the Amazon Q Business application. Status *string `locationName:"status" type:"string" enum:"ApplicationStatus"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -11463,6 +11685,12 @@ func (s *GetApplicationOutput) SetError(v *ErrorDetail) *GetApplicationOutput { return s } +// SetIdentityCenterApplicationArn sets the IdentityCenterApplicationArn field's value. +func (s *GetApplicationOutput) SetIdentityCenterApplicationArn(v string) *GetApplicationOutput { + s.IdentityCenterApplicationArn = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *GetApplicationOutput) SetRoleArn(v string) *GetApplicationOutput { s.RoleArn = &v @@ -11493,8 +11721,9 @@ type GetChatControlsConfigurationInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -11562,18 +11791,22 @@ type GetChatControlsConfigurationOutput struct { // The phrases blocked from chat by your chat control configuration. BlockedPhrases *BlockedPhrasesConfiguration `locationName:"blockedPhrases" type:"structure"` + // The configuration details for CREATOR_MODE. + CreatorModeConfiguration *AppliedCreatorModeConfiguration `locationName:"creatorModeConfiguration" type:"structure"` + // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // The response scope configured for a Amazon Q application. This determines + // 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. ResponseScope *string `locationName:"responseScope" type:"string" enum:"ResponseScope"` - // The topic specific controls configured for a Amazon Q application. + // The topic specific controls configured for a Amazon Q Business application. TopicConfigurations []*TopicConfiguration `locationName:"topicConfigurations" type:"list"` } @@ -11601,6 +11834,12 @@ func (s *GetChatControlsConfigurationOutput) SetBlockedPhrases(v *BlockedPhrases return s } +// SetCreatorModeConfiguration sets the CreatorModeConfiguration field's value. +func (s *GetChatControlsConfigurationOutput) SetCreatorModeConfiguration(v *AppliedCreatorModeConfiguration) *GetChatControlsConfigurationOutput { + s.CreatorModeConfiguration = v + return s +} + // SetNextToken sets the NextToken field's value. func (s *GetChatControlsConfigurationOutput) SetNextToken(v string) *GetChatControlsConfigurationOutput { s.NextToken = &v @@ -11622,7 +11861,7 @@ func (s *GetChatControlsConfigurationOutput) SetTopicConfigurations(v []*TopicCo type GetDataSourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -11705,7 +11944,7 @@ func (s *GetDataSourceInput) SetIndexId(v string) *GetDataSourceInput { type GetDataSourceOutput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` // The Unix timestamp when the data source connector was created. @@ -11745,7 +11984,7 @@ type GetDataSourceOutput struct { // caused the data source connector to fail. Status *string `locationName:"status" type:"string" enum:"DataSourceStatus"` - // The schedule for Amazon Q to update the index. + // The schedule for Amazon Q Business to update the index. SyncSchedule *string `locationName:"syncSchedule" type:"string"` // The type of the data source connector. For example, S3. @@ -12005,12 +12244,12 @@ func (s *GetGroupOutput) SetStatusHistory(v []*GroupStatusDetail) *GetGroupOutpu type GetIndexInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application connected to the index. + // The identifier of the Amazon Q Business application connected to the index. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q index you want information on. + // The identifier of the Amazon Q Business index you want information on. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -12071,19 +12310,19 @@ func (s *GetIndexInput) SetIndexId(v string) *GetIndexInput { type GetIndexOutput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application associated with the index. + // The identifier of the Amazon Q Business application associated with the index. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` - // The storage capacity units chosen for your Amazon Q index. + // The storage capacity units chosen for your Amazon Q Business index. CapacityConfiguration *IndexCapacityConfiguration `locationName:"capacityConfiguration" type:"structure"` - // The Unix timestamp when the Amazon Q index was created. + // The Unix timestamp when the Amazon Q Business index was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The description for the Amazon Q index. + // The description for the Amazon Q Business index. Description *string `locationName:"description" type:"string"` - // The name of the Amazon Q index. + // The name of the Amazon Q Business index. DisplayName *string `locationName:"displayName" min:"1" type:"string"` // Configuration information for document attributes or metadata. Document metadata @@ -12096,10 +12335,10 @@ type GetIndexOutput struct { // message that explains why. Error *ErrorDetail `locationName:"error" type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Q index. + // The Amazon Resource Name (ARN) of the Amazon Q Business index. IndexArn *string `locationName:"indexArn" type:"string"` - // The identifier of the Amazon Q index. + // The identifier of the Amazon Q Business index. IndexId *string `locationName:"indexId" min:"36" type:"string"` // Provides information about the number of documents indexed. @@ -12110,7 +12349,7 @@ type GetIndexOutput struct { // a message that explains why. Status *string `locationName:"status" type:"string" enum:"IndexStatus"` - // The Unix timestamp when the Amazon Q index was last updated. + // The Unix timestamp when the Amazon Q Business index was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` } @@ -12276,7 +12515,7 @@ type GetPluginOutput struct { // The identifier of the application which contains the plugin. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` - // Authentication configuration information for an Amazon Q plugin. + // Authentication configuration information for an Amazon Q Business plugin. AuthConfiguration *PluginAuthConfiguration `locationName:"authConfiguration" type:"structure"` // The timestamp for when the plugin was created. @@ -12386,7 +12625,7 @@ func (s *GetPluginOutput) SetUpdatedAt(v time.Time) *GetPluginOutput { type GetRetrieverInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application using the retriever. + // The identifier of the Amazon Q Business application using the retriever. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -12452,11 +12691,11 @@ func (s *GetRetrieverInput) SetRetrieverId(v string) *GetRetrieverInput { type GetRetrieverOutput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application using the retriever. + // The identifier of the Amazon Q Business application using the retriever. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` - // Provides information on how the retriever used for your Amazon Q application - // is configured. + // Provides information on how the retriever used for your Amazon Q Business + // application is configured. Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure"` // The Unix timestamp when the retriever was created. @@ -12663,12 +12902,12 @@ func (s *GetUserOutput) SetUserAliases(v []*UserAlias) *GetUserOutput { type GetWebExperienceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application linked to the web experience. + // The identifier of the Amazon Q Business application linked to the web experience. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q web experience. + // The identifier of the Amazon Q Business web experience. // // WebExperienceId is a required field WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"` @@ -12729,48 +12968,53 @@ func (s *GetWebExperienceInput) SetWebExperienceId(v string) *GetWebExperienceIn type GetWebExperienceOutput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application linked to the web experience. + // The identifier of the Amazon Q Business application linked to the web experience. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` - // The authentication configuration information for your Amazon Q web experience. + // The authentication configuration information for your Amazon Q Business web + // experience. AuthenticationConfiguration *WebExperienceAuthConfiguration `locationName:"authenticationConfiguration" type:"structure"` // The Unix timestamp when the retriever was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The endpoint of your Amazon Q web experience. + // The endpoint of your Amazon Q Business web experience. DefaultEndpoint *string `locationName:"defaultEndpoint" min:"1" type:"string"` // When the Status field value is FAILED, the ErrorMessage field contains a // description of the error that caused the data source connector to fail. Error *ErrorDetail `locationName:"error" type:"structure"` + // The Amazon Resource Name (ARN) of the service role attached to your web experience. + RoleArn *string `locationName:"roleArn" type:"string"` + // Determines whether sample prompts are enabled in the web experience for an // end user. SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"` - // 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. Status *string `locationName:"status" type:"string" enum:"WebExperienceStatus"` - // The subtitle for your Amazon Q web experience. + // The subtitle for your Amazon Q Business web experience. Subtitle *string `locationName:"subtitle" type:"string"` - // The title for your Amazon Q web experience. + // The title for your Amazon Q Business web experience. Title *string `locationName:"title" type:"string"` // The Unix timestamp when the data source connector was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` // The Amazon Resource Name (ARN) of the role with the permission to access - // the Amazon Q web experience and required resources. + // the Amazon Q Business web experience and required resources. WebExperienceArn *string `locationName:"webExperienceArn" type:"string"` - // The identifier of the Amazon Q web experience. + // The identifier of the Amazon Q Business web experience. WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"` - // The customized welcome message for end users of an Amazon Q web experience. + // The customized welcome message for end users of an Amazon Q Business web + // experience. WelcomeMessage *string `locationName:"welcomeMessage" type:"string"` } @@ -12822,6 +13066,12 @@ func (s *GetWebExperienceOutput) SetError(v *ErrorDetail) *GetWebExperienceOutpu return s } +// SetRoleArn sets the RoleArn field's value. +func (s *GetWebExperienceOutput) SetRoleArn(v string) *GetWebExperienceOutput { + s.RoleArn = &v + return s +} + // SetSamplePromptsControlMode sets the SamplePromptsControlMode field's value. func (s *GetWebExperienceOutput) SetSamplePromptsControlMode(v string) *GetWebExperienceOutput { s.SamplePromptsControlMode = &v @@ -12871,7 +13121,7 @@ func (s *GetWebExperienceOutput) SetWelcomeMessage(v string) *GetWebExperienceOu } // 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. +// Amazon Q Business chat results only from document a user has access to. type GroupMembers struct { _ struct{} `type:"structure"` @@ -12958,7 +13208,7 @@ type GroupStatusDetail struct { // The details of an error associated a group status. ErrorDetail *ErrorDetail `locationName:"errorDetail" type:"structure"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` // The status of a group. @@ -13035,14 +13285,14 @@ func (s *GroupSummary) SetGroupName(v string) *GroupSummary { // Provides the configuration information for invoking a Lambda function in // Lambda to alter document metadata and content when ingesting documents into -// Amazon Q. +// Amazon Q Business. // // You can configure your Lambda function using PreExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html) // 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 +// If you want to apply advanced alterations on the Amazon Q Business structured +// documents, you must configure your Lambda function using PostExtractionHookConfiguration // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html). // // You can only invoke one Lambda function. However, this function can invoke @@ -13055,7 +13305,8 @@ type HookConfiguration struct { // 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. + // values, then Amazon Q Business should invoke a function that inserts the + // current date-time. InvocationCondition *DocumentAttributeCondition `locationName:"invocationCondition" type:"structure"` // The Amazon Resource Name (ARN) of a role with permission to run a Lambda @@ -13137,7 +13388,7 @@ func (s *HookConfiguration) SetS3BucketName(v string) *HookConfiguration { return s } -// Summary information for your Amazon Q index. +// Summary information for your Amazon Q Business index. type Index struct { _ struct{} `type:"structure"` @@ -13210,7 +13461,7 @@ func (s *Index) SetUpdatedAt(v time.Time) *Index { type IndexCapacityConfiguration struct { _ struct{} `type:"structure"` - // The number of storage units configured for an Amazon Q index. + // The number of storage units configured for an Amazon Q Business index. Units *int64 `locationName:"units" min:"1" type:"integer"` } @@ -13284,7 +13535,7 @@ func (s *IndexStatistics) SetTextDocumentStatistics(v *TextDocumentStatistics) * } // Provides the configuration information for applying basic logic to alter -// document metadata and content when ingesting documents into Amazon Q. +// 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html). @@ -13294,7 +13545,7 @@ type InlineDocumentEnrichmentConfiguration struct { _ struct{} `type:"structure"` // The condition used for the target document attribute or metadata field when - // ingesting documents into Amazon Q. You use this with DocumentAttributeTarget + // ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget // (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html) // to apply the condition. // @@ -13304,10 +13555,10 @@ type InlineDocumentEnrichmentConfiguration struct { // '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. + // 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. Condition *DocumentAttributeCondition `locationName:"condition" type:"structure"` // TRUE to delete content if the condition used for the target attribute is @@ -13315,7 +13566,7 @@ type InlineDocumentEnrichmentConfiguration struct { DocumentContentOperator *string `locationName:"documentContentOperator" type:"string" enum:"DocumentContentOperator"` // The target document attribute or metadata field you want to alter when ingesting - // documents into Amazon Q. + // 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' @@ -13323,11 +13574,11 @@ type InlineDocumentEnrichmentConfiguration struct { // 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). - // Amazon Q will then map your newly created document attribute to your index - // field. + // 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 (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html). + // Amazon Q Business will then map your newly created document attribute to + // your index field. // // You can also use this with DocumentAttributeCondition (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html). Target *DocumentAttributeTarget `locationName:"target" type:"structure"` @@ -13389,8 +13640,8 @@ func (s *InlineDocumentEnrichmentConfiguration) SetTarget(v *DocumentAttributeTa return s } -// An issue occurred with the internal server used for your Amazon Q service. -// Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) +// An issue occurred with the internal server used for your Amazon Q Business +// service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. type InternalServerException struct { _ struct{} `type:"structure"` @@ -13574,12 +13825,12 @@ func (s *LicenseNotFoundException) RequestID() string { type ListApplicationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The maximum number of Amazon Q applications to return. + // The maximum number of Amazon Q Business applications to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -13633,11 +13884,11 @@ type ListApplicationsOutput struct { _ struct{} `type:"structure"` // An array of summary information on the configuration of one or more Amazon - // Q applications. + // Q Business applications. Applications []*Application `locationName:"applications" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -13674,23 +13925,22 @@ func (s *ListApplicationsOutput) SetNextToken(v string) *ListApplicationsOutput type ListConversationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The maximum number of Amazon Q conversations to return. + // The maximum number of Amazon Q Business conversations to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` - // The identifier of the user involved in the Amazon Q web experience conversation. - // - // UserId is a required field - UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string" required:"true"` + // The identifier of the user involved in the Amazon Q Business web experience + // conversation. + UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -13726,9 +13976,6 @@ func (s *ListConversationsInput) Validate() error { if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.UserId == nil { - invalidParams.Add(request.NewErrParamRequired("UserId")) - } if s.UserId != nil && len(*s.UserId) < 1 { invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } @@ -13767,11 +14014,11 @@ type ListConversationsOutput struct { _ struct{} `type:"structure"` // An array of summary information on the configuration of one or more Amazon - // Q web experiences. + // Q Business web experiences. Conversations []*Conversation `locationName:"conversations" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -13808,7 +14055,8 @@ func (s *ListConversationsOutput) SetNextToken(v string) *ListConversationsOutpu type ListDataSourceSyncJobsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application connected to the data source. + // The identifier of the Amazon Q Business application connected to the data + // source. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -13821,7 +14069,7 @@ type ListDataSourceSyncJobsInput struct { // The end time of the data source connector sync. EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp"` - // The identifier of the index used with the Amazon Q data source connector. + // The identifier of the index used with the Amazon Q Business data source connector. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -13830,8 +14078,8 @@ type ListDataSourceSyncJobsInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // Amazon Q Business returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of responses. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The start time of the data source connector sync. @@ -13948,8 +14196,8 @@ type ListDataSourceSyncJobsOutput struct { // A history of synchronization jobs for the data source connector. History []*DataSourceSyncJob `locationName:"history" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -13986,7 +14234,8 @@ func (s *ListDataSourceSyncJobsOutput) SetNextToken(v string) *ListDataSourceSyn type ListDataSourcesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application linked to the data source connectors. + // The identifier of the Amazon Q Business application linked to the data source + // connectors. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -14000,8 +14249,9 @@ type ListDataSourcesInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -14081,8 +14331,9 @@ type ListDataSourcesOutput struct { // An array of summary information for one or more data source connector. DataSources []*DataSource `locationName:"dataSources" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -14136,8 +14387,8 @@ type ListDocumentsInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // Amazon Q Business returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of documents. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -14227,8 +14478,8 @@ type ListDocumentsOutput struct { DocumentDetailList []*DocumentDetails `locationName:"documentDetailList" type:"list"` // 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. + // Amazon Q Business returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of documents. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -14284,8 +14535,9 @@ type ListGroupsInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The timestamp identifier used for the latest PUT or DELETE action for mapping @@ -14389,9 +14641,9 @@ type ListGroupsOutput struct { // Summary information for list of groups that are mapped to users. Items []*GroupSummary `locationName:"items" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -14428,7 +14680,7 @@ func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput { type ListIndicesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application connected to the index. + // The identifier of the Amazon Q Business application connected to the index. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -14437,8 +14689,8 @@ type ListIndicesInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -14506,8 +14758,8 @@ type ListIndicesOutput struct { // An array of information on the items in one or more indexes. Indices []*Index `locationName:"indices" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -14544,12 +14796,12 @@ func (s *ListIndicesOutput) SetNextToken(v string) *ListIndicesOutput { type ListMessagesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the Amazon Q application. + // The identifier for the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The identifier of the Amazon Q web experience conversation. + // The identifier of the Amazon Q Business web experience conversation. // // ConversationId is a required field ConversationId *string `location:"uri" locationName:"conversationId" min:"36" type:"string" required:"true"` @@ -14557,14 +14809,13 @@ type ListMessagesInput struct { // The maximum number of messages to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` - // The identifier of the user involved in the Amazon Q web experience conversation. - // - // UserId is a required field - UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string" required:"true"` + // The identifier of the user involved in the Amazon Q Business web experience + // conversation. + UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -14606,9 +14857,6 @@ func (s *ListMessagesInput) Validate() error { if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.UserId == nil { - invalidParams.Add(request.NewErrParamRequired("UserId")) - } if s.UserId != nil && len(*s.UserId) < 1 { invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } @@ -14655,8 +14903,8 @@ type ListMessagesOutput struct { // An array of information on one or more messages. Messages []*Message `locationName:"messages" type:"list"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` } @@ -14702,8 +14950,8 @@ type ListPluginsInput struct { MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // Amazon Q Business returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of plugins. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -14769,8 +15017,8 @@ type ListPluginsOutput struct { _ struct{} `type:"structure"` // 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. + // Amazon Q Business returns a pagination token in the response. You can use + // this pagination token to retrieve the next set of plugins. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // Information about a configured plugin. @@ -14810,7 +15058,7 @@ func (s *ListPluginsOutput) SetPlugins(v []*Plugin) *ListPluginsOutput { type ListRetrieversInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application using the retriever. + // The identifier of the Amazon Q Business application using the retriever. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -14818,8 +15066,8 @@ type ListRetrieversInput struct { // The maximum number of retrievers returned. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -14884,8 +15132,8 @@ func (s *ListRetrieversInput) SetNextToken(v string) *ListRetrieversInput { type ListRetrieversOutput struct { _ struct{} `type:"structure"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // An array of summary information for one or more retrievers. @@ -14925,8 +15173,8 @@ func (s *ListRetrieversOutput) SetRetrievers(v []*Retriever) *ListRetrieversOutp type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The Amazon Resource Name (ARN) of the Amazon Q application or data source - // to get a list of tags for. + // The Amazon Resource Name (ARN) of the Amazon Q Business application or data + // source to get a list of tags for. // // ResourceARN is a required field ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"` @@ -14975,7 +15223,8 @@ func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // A list of tags associated with the Amazon Q application or data source. + // A list of tags associated with the Amazon Q Business application or data + // source. Tags []*Tag `locationName:"tags" type:"list"` } @@ -15006,17 +15255,18 @@ func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput type ListWebExperiencesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application linked to the listed web experiences. + // The identifier of the Amazon Q Business application linked to the listed + // web experiences. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The maximum number of Amazon Q Web Experiences to return. + // The maximum number of Amazon Q Business Web Experiences to return. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // 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. + // 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. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } @@ -15081,11 +15331,11 @@ func (s *ListWebExperiencesInput) SetNextToken(v string) *ListWebExperiencesInpu type ListWebExperiencesOutput struct { _ struct{} `type:"structure"` - // 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. + // 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. NextToken *string `locationName:"nextToken" min:"1" type:"string"` - // An array of summary information for one or more Amazon Q experiences. + // An array of summary information for one or more Amazon Q Business experiences. WebExperiences []*WebExperience `locationName:"webExperiences" type:"list"` } @@ -15237,32 +15487,32 @@ func (s *MemberUser) SetUserId(v string) *MemberUser { return s } -// A message in an Amazon Q web experience. +// A message in an Amazon Q Business web experience. type Message struct { _ struct{} `type:"structure"` - // 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 + // 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. + // pre-populated by Amazon Q Business. ActionReview *ActionReview `locationName:"actionReview" type:"structure"` - // A file directly uploaded into an Amazon Q web experience chat. + // A file directly uploaded into an Amazon Q Business web experience chat. Attachments []*AttachmentOutput_ `locationName:"attachments" type:"list"` - // The content of the Amazon Q web experience message. + // The content of the Amazon Q Business web experience message. Body *string `locationName:"body" type:"string"` - // The identifier of the Amazon Q web experience message. + // The identifier of the Amazon Q Business web experience message. MessageId *string `locationName:"messageId" min:"1" type:"string"` - // The source documents used to generate Amazon Q web experience message. + // The source documents used to generate Amazon Q Business web experience message. SourceAttribution []*SourceAttribution `locationName:"sourceAttribution" type:"list"` - // The timestamp of the first Amazon Q web experience message. + // The timestamp of the first Amazon Q Business web experience message. Time *time.Time `locationName:"time" type:"timestamp"` - // The type of Amazon Q message, whether HUMAN or AI generated. + // The type of Amazon Q Business message, whether HUMAN or AI generated. Type *string `locationName:"type" type:"string" enum:"MessageType"` } @@ -15406,15 +15656,15 @@ func (s *MessageUsefulnessFeedback) SetUsefulness(v string) *MessageUsefulnessFe return s } -// Configuration information for an Amazon Q index. +// Configuration information for an Amazon Q Business index. type NativeIndexConfiguration struct { _ struct{} `type:"structure"` - // Overrides the default boosts applied by Amazon Q to supported document attribute - // data types. + // Overrides the default boosts applied by Amazon Q Business to supported document + // attribute data types. BoostingOverride map[string]*DocumentAttributeBoostingConfiguration `locationName:"boostingOverride" min:"1" type:"map"` - // The identifier for the Amazon Q index. + // The identifier for the Amazon Q Business index. // // IndexId is a required field IndexId *string `locationName:"indexId" min:"36" type:"string" required:"true"` @@ -15481,8 +15731,8 @@ func (s *NativeIndexConfiguration) SetIndexId(v string) *NativeIndexConfiguratio // 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). +// For more information on how boosting document attributes work in Amazon Q +// Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). type NumberAttributeBoostingConfiguration struct { _ struct{} `type:"structure"` @@ -15544,8 +15794,8 @@ func (s *NumberAttributeBoostingConfiguration) SetBoostingType(v string) *Number type OAuth2ClientCredentialConfiguration struct { _ struct{} `type:"structure"` - // The ARN of an IAM role used by Amazon Q to access the OAuth 2.0 authentication - // credentials stored in a Secrets Manager secret. + // 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. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` @@ -15603,7 +15853,7 @@ func (s *OAuth2ClientCredentialConfiguration) SetSecretArn(v string) *OAuth2Clie return s } -// Information about an Amazon Q plugin and its configuration. +// Information about an Amazon Q Business plugin and its configuration. type Plugin struct { _ struct{} `type:"structure"` @@ -15689,7 +15939,7 @@ func (s *Plugin) SetUpdatedAt(v time.Time) *Plugin { return s } -// Authentication configuration information for an Amazon Q plugin. +// Authentication configuration information for an Amazon Q Business plugin. type PluginAuthConfiguration struct { _ struct{} `type:"structure"` @@ -15752,8 +16002,62 @@ func (s *PluginAuthConfiguration) SetOAuth2ClientCredentialConfiguration(v *OAut return s } +// Configuration information required to invoke chat in PLUGIN_MODE. +// +// For more information, see Admin controls and guardrails (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html), +// Plugins (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html), +// and Conversation settings (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope). +type PluginConfiguration struct { + _ struct{} `type:"structure"` + + // The identifier of the plugin you want to use. + // + // PluginId is a required field + PluginId *string `locationName:"pluginId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PluginConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PluginConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PluginConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PluginConfiguration"} + if s.PluginId == nil { + invalidParams.Add(request.NewErrParamRequired("PluginId")) + } + if s.PluginId != nil && len(*s.PluginId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("PluginId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPluginId sets the PluginId field's value. +func (s *PluginConfiguration) SetPluginId(v string) *PluginConfiguration { + s.PluginId = &v + return s +} + // Provides user and group information used for filtering documents to use for -// generating Amazon Q conversation responses. +// generating Amazon Q Business conversation responses. type Principal struct { _ struct{} `type:"structure"` @@ -15975,9 +16279,7 @@ type PutFeedbackInput struct { MessageUsefulness *MessageUsefulnessFeedback `locationName:"messageUsefulness" type:"structure"` // The identifier of the user giving the feedback. - // - // UserId is a required field - UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string" required:"true"` + UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -16019,9 +16321,6 @@ func (s *PutFeedbackInput) Validate() error { if s.MessageId != nil && len(*s.MessageId) < 36 { invalidParams.Add(request.NewErrParamMinLen("MessageId", 36)) } - if s.UserId == nil { - invalidParams.Add(request.NewErrParamRequired("UserId")) - } if s.UserId != nil && len(*s.UserId) < 1 { invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } @@ -16113,7 +16412,7 @@ type PutGroupInput struct { DataSourceId *string `locationName:"dataSourceId" min:"36" type:"string"` // 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. + // Amazon Q Business chat results only from document a user has access to. // // GroupMembers is a required field GroupMembers *GroupMembers `locationName:"groupMembers" type:"structure" required:"true"` @@ -16336,17 +16635,17 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Summary information for the retriever used for your Amazon Q application. +// Summary information for the retriever used for your Amazon Q Business application. type Retriever struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application using the retriever. + // The identifier of the Amazon Q Business application using the retriever. ApplicationId *string `locationName:"applicationId" min:"36" type:"string"` // The name of your retriever. DisplayName *string `locationName:"displayName" min:"1" type:"string"` - // The identifier of the retriever used by your Amazon Q application. + // The identifier of the retriever used by your Amazon Q Business application. RetrieverId *string `locationName:"retrieverId" min:"36" type:"string"` // The status of your retriever. @@ -16404,17 +16703,17 @@ func (s *Retriever) SetType(v string) *Retriever { return s } -// Provides information on how the retriever used for your Amazon Q application -// is configured. +// Provides information on how the retriever used for your Amazon Q Business +// application is configured. type RetrieverConfiguration struct { _ struct{} `type:"structure"` // Provides information on how the Amazon Kendra index used as a retriever for - // your Amazon Q application is configured. + // your Amazon Q Business application is configured. KendraIndexConfiguration *KendraIndexConfiguration `locationName:"kendraIndexConfiguration" type:"structure"` - // Provides information on how a Amazon Q index used as a retriever for your - // Amazon Q application is configured. + // Provides information on how a Amazon Q Business index used as a retriever + // for your Amazon Q Business application is configured. NativeIndexConfiguration *NativeIndexConfiguration `locationName:"nativeIndexConfiguration" type:"structure"` } @@ -16468,8 +16767,8 @@ func (s *RetrieverConfiguration) SetNativeIndexConfiguration(v *NativeIndexConfi return s } -// Guardrail rules for an Amazon Q application. Amazon Q supports only one rule -// at a time. +// Guardrail rules for an Amazon Q Business application. Amazon Q Business supports +// only one rule at a time. type Rule struct { _ struct{} `type:"structure"` @@ -16552,12 +16851,12 @@ func (s *Rule) SetRuleType(v string) *Rule { type RuleConfiguration struct { _ struct{} `type:"structure"` - // A rule for configuring how Amazon Q responds when it encounters a a blocked - // topic. + // A rule for configuring how Amazon Q Business responds when it encounters + // a a blocked topic. ContentBlockerRule *ContentBlockerRule `locationName:"contentBlockerRule" type:"structure"` - // Rules for retrieving content from data sources connected to a Amazon Q application - // for a specific topic control configuration. + // Rules for retrieving content from data sources connected to a Amazon Q Business + // application for a specific topic control configuration. ContentRetrievalRule *ContentRetrievalRule `locationName:"contentRetrievalRule" type:"structure"` } @@ -16606,8 +16905,8 @@ func (s *RuleConfiguration) SetContentRetrievalRule(v *ContentRetrievalRule) *Ru return s } -// Information required for Amazon Q to find a specific file in an Amazon S3 -// bucket. +// Information required for Amazon Q Business to find a specific file in an +// Amazon S3 bucket. type S3 struct { _ struct{} `type:"structure"` @@ -16675,7 +16974,7 @@ func (s *S3) SetKey(v string) *S3 { } // Provides the SAML 2.0 compliant identity provider (IdP) configuration information -// Amazon Q needs to deploy a Amazon Q web experience. +// Amazon Q Business needs to deploy a Amazon Q Business web experience. type SamlConfiguration struct { _ struct{} `type:"structure"` @@ -16685,8 +16984,8 @@ type SamlConfiguration struct { MetadataXML *string `locationName:"metadataXML" min:"1000" type:"string" required:"true"` // 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. + // authenticate into their Amazon Q Business web experience, containing the + // relevant Amazon Q Business permissions for conversing with Amazon Q Business. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` @@ -16770,7 +17069,7 @@ func (s *SamlConfiguration) SetUserIdAttribute(v string) *SamlConfiguration { return s } -// You have exceeded the set limits for your Amazon Q service. +// You have exceeded the set limits for your Amazon Q Business service. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -16845,11 +17144,11 @@ func (s *ServiceQuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } -// The documents used to generate an Amazon Q web experience response. +// The documents used to generate an Amazon Q Business web experience response. type SourceAttribution struct { _ struct{} `type:"structure"` - // The number attached to a citation in an Amazon Q generated response. + // The number attached to a citation in an Amazon Q Business generated response. CitationNumber *int64 `locationName:"citationNumber" type:"integer"` // The content extract from the document on which the generated response is @@ -16859,14 +17158,15 @@ type SourceAttribution struct { // A text extract from a source document that is used for source attribution. TextMessageSegments []*TextSegment `locationName:"textMessageSegments" type:"list"` - // The title of the document which is the source for the Amazon Q generated + // The title of the document which is the source for the Amazon Q Business generated // response. Title *string `locationName:"title" min:"1" type:"string"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` - // The URL of the document which is the source for the Amazon Q generated response. + // The URL of the document which is the source for the Amazon Q Business generated + // response. Url *string `locationName:"url" min:"1" type:"string"` } @@ -16927,7 +17227,8 @@ func (s *SourceAttribution) SetUrl(v string) *SourceAttribution { type StartDataSourceSyncJobInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of Amazon Q application the data source is connected to. + // The identifier of Amazon Q Business application the data source is connected + // to. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -17041,8 +17342,8 @@ func (s *StartDataSourceSyncJobOutput) SetExecutionId(v string) *StartDataSource type StopDataSourceSyncJobInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier of the Amazon Q application that the data source is connected - // to. + // The identifier of the Amazon Q Business application that the data source + // is connected to. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -17052,7 +17353,7 @@ type StopDataSourceSyncJobInput struct { // DataSourceId is a required field DataSourceId *string `location:"uri" locationName:"dataSourceId" min:"36" type:"string" required:"true"` - // The identifier of the index used with the Amazon Q data source connector. + // The identifier of the index used with the Amazon Q Business data source connector. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -17153,8 +17454,8 @@ func (s StopDataSourceSyncJobOutput) GoString() string { // 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). +// For more information on how boosting document attributes work in Amazon Q +// Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). type StringAttributeBoostingConfiguration struct { _ struct{} `type:"structure"` @@ -17222,8 +17523,8 @@ func (s *StringAttributeBoostingConfiguration) SetBoostingLevel(v string) *Strin // 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). +// For more information on how boosting document attributes work in Amazon Q +// Business, see Boosting using document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html). type StringListAttributeBoostingConfiguration struct { _ struct{} `type:"structure"` @@ -17277,7 +17578,7 @@ type Tag struct { _ struct{} `type:"structure"` // The key for the tag. Keys are not case sensitive and must be unique for the - // Amazon Q application or data source. + // Amazon Q Business application or data source. // // Key is a required field Key *string `locationName:"key" min:"1" type:"string" required:"true"` @@ -17341,14 +17642,14 @@ func (s *Tag) SetValue(v string) *Tag { type TagResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Amazon Q application or data source - // to tag. + // The Amazon Resource Name (ARN) of the Amazon Q Business application or data + // source to tag. // // ResourceARN is a required field ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"` - // 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. + // 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. // // Tags is a required field Tags []*Tag `locationName:"tags" type:"list" required:"true"` @@ -17585,7 +17886,7 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } -// The topic specific controls configured for an Amazon Q application. +// The topic specific controls configured for an Amazon Q Business application. type TopicConfiguration struct { _ struct{} `type:"structure"` @@ -17682,14 +17983,14 @@ func (s *TopicConfiguration) SetRules(v []*Rule) *TopicConfiguration { type UntagResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The Amazon Resource Name (ARN) of the Amazon Q application, or data source - // to remove the tag from. + // The Amazon Resource Name (ARN) of the Amazon Q Business application, or data + // source to remove the tag from. // // ResourceARN is a required field ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"` - // 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. + // 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. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` @@ -17769,7 +18070,7 @@ func (s UntagResourceOutput) GoString() string { type UpdateApplicationInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application. + // The identifier of the Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -17777,14 +18078,14 @@ type UpdateApplicationInput struct { // An option to allow end users to upload files directly during chat. AttachmentsConfiguration *AttachmentsConfiguration `locationName:"attachmentsConfiguration" type:"structure"` - // A description for the Amazon Q application. + // A description for the Amazon Q Business application. Description *string `locationName:"description" type:"string"` - // A name for the Amazon Q application. + // A name for the Amazon Q Business application. DisplayName *string `locationName:"displayName" min:"1" type:"string"` // An Amazon Web Services Identity and Access Management (IAM) role that gives - // Amazon Q permission to access Amazon CloudWatch logs and metrics. + // Amazon Q Business permission to access Amazon CloudWatch logs and metrics. RoleArn *string `locationName:"roleArn" type:"string"` } @@ -17893,10 +18194,13 @@ type UpdateChatControlsConfigurationInput struct { // The phrases blocked from chat by your chat control configuration. BlockedPhrasesConfigurationUpdate *BlockedPhrasesConfigurationUpdate `locationName:"blockedPhrasesConfigurationUpdate" type:"structure"` - // A token that you provide to identify the request to update a Amazon Q application - // chat configuration. + // A token that you provide to identify the request to update a Amazon Q Business + // application chat configuration. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + // The configuration details for CREATOR_MODE. + CreatorModeConfiguration *CreatorModeConfiguration `locationName:"creatorModeConfiguration" type:"structure"` + // 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 @@ -17940,6 +18244,11 @@ func (s *UpdateChatControlsConfigurationInput) Validate() error { if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } + if s.CreatorModeConfiguration != nil { + if err := s.CreatorModeConfiguration.Validate(); err != nil { + invalidParams.AddNested("CreatorModeConfiguration", err.(request.ErrInvalidParams)) + } + } if s.TopicConfigurationsToCreateOrUpdate != nil { for i, v := range s.TopicConfigurationsToCreateOrUpdate { if v == nil { @@ -17985,6 +18294,12 @@ func (s *UpdateChatControlsConfigurationInput) SetClientToken(v string) *UpdateC return s } +// SetCreatorModeConfiguration sets the CreatorModeConfiguration field's value. +func (s *UpdateChatControlsConfigurationInput) SetCreatorModeConfiguration(v *CreatorModeConfiguration) *UpdateChatControlsConfigurationInput { + s.CreatorModeConfiguration = v + return s +} + // SetResponseScope sets the ResponseScope field's value. func (s *UpdateChatControlsConfigurationInput) SetResponseScope(v string) *UpdateChatControlsConfigurationInput { s.ResponseScope = &v @@ -18028,7 +18343,8 @@ func (s UpdateChatControlsConfigurationOutput) GoString() string { type UpdateDataSourceInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application the data source is attached to. + // The identifier of the Amazon Q Business application the data source is attached + // to. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` @@ -18205,19 +18521,19 @@ func (s UpdateDataSourceOutput) GoString() string { type UpdateIndexInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application connected to the index. + // The identifier of the Amazon Q Business application connected to the index. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The storage capacity units you want to provision for your Amazon Q index. - // You can add and remove capacity to fit your usage needs. + // 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. CapacityConfiguration *IndexCapacityConfiguration `locationName:"capacityConfiguration" type:"structure"` - // The description of the Amazon Q index. + // The description of the Amazon Q Business index. Description *string `locationName:"description" type:"string"` - // The name of the Amazon Q index. + // The name of the Amazon Q Business index. DisplayName *string `locationName:"displayName" min:"1" type:"string"` // Configuration information for document metadata or fields. Document metadata @@ -18226,7 +18542,7 @@ type UpdateIndexInput struct { // see Understanding document attributes (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes-types.html#doc-attributes). DocumentAttributeConfigurations []*DocumentAttributeConfiguration `locationName:"documentAttributeConfigurations" min:"1" type:"list"` - // The identifier of the Amazon Q index. + // The identifier of the Amazon Q Business index. // // IndexId is a required field IndexId *string `location:"uri" locationName:"indexId" min:"36" type:"string" required:"true"` @@ -18489,13 +18805,13 @@ func (s UpdatePluginOutput) GoString() string { type UpdateRetrieverInput struct { _ struct{} `type:"structure"` - // The identifier of your Amazon Q application. + // The identifier of your Amazon Q Business application. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // Provides information on how the retriever used for your Amazon Q application - // is configured. + // Provides information on how the retriever used for your Amazon Q Business + // application is configured. Configuration *RetrieverConfiguration `locationName:"configuration" type:"structure"` // The name of your retriever. @@ -18767,30 +19083,31 @@ func (s *UpdateUserOutput) SetUserAliasesUpdated(v []*UserAlias) *UpdateUserOutp type UpdateWebExperienceInput struct { _ struct{} `type:"structure"` - // The identifier of the Amazon Q application attached to the web experience. + // The identifier of the Amazon Q Business application attached to the web experience. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"` - // The authentication configuration of the Amazon Q web experience. + // The authentication configuration of the Amazon Q Business web experience. AuthenticationConfiguration *WebExperienceAuthConfiguration `locationName:"authenticationConfiguration" type:"structure"` // Determines whether sample prompts are enabled in the web experience for an // end user. SamplePromptsControlMode *string `locationName:"samplePromptsControlMode" type:"string" enum:"WebExperienceSamplePromptsControlMode"` - // The subtitle of the Amazon Q web experience. + // The subtitle of the Amazon Q Business web experience. Subtitle *string `locationName:"subtitle" type:"string"` - // The title of the Amazon Q web experience. + // The title of the Amazon Q Business web experience. Title *string `locationName:"title" type:"string"` - // The identifier of the Amazon Q web experience. + // The identifier of the Amazon Q Business web experience. // // WebExperienceId is a required field WebExperienceId *string `location:"uri" locationName:"webExperienceId" min:"36" type:"string" required:"true"` - // A customized welcome message for an end user in an Amazon Q web experience. + // A customized welcome message for an end user in an Amazon Q Business web + // experience. WelcomeMessage *string `locationName:"welcomeMessage" type:"string"` } @@ -18903,7 +19220,7 @@ func (s UpdateWebExperienceOutput) GoString() string { return s.String() } -// Aliases attached to a user id within an Amazon Q application. +// Aliases attached to a user id within an Amazon Q Business application. type UserAlias struct { _ struct{} `type:"structure"` @@ -19019,8 +19336,8 @@ func (s *UsersAndGroups) SetUserIds(v []*string) *UsersAndGroups { return s } -// The input doesn't meet the constraints set by the Amazon Q service. Provide -// the correct input and try again. +// The input doesn't meet the constraints set by the Amazon Q Business service. +// Provide the correct input and try again. type ValidationException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -19093,8 +19410,8 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } -// The input failed to meet the constraints specified by Amazon Q in a specified -// field. +// The input failed to meet the constraints specified by Amazon Q Business in +// a specified field. type ValidationExceptionField struct { _ struct{} `type:"structure"` @@ -19139,24 +19456,24 @@ func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { return s } -// Provides information for an Amazon Q web experience. +// Provides information for an Amazon Q Business web experience. type WebExperience struct { _ struct{} `type:"structure"` - // The Unix timestamp when the Amazon Q application was last updated. + // The Unix timestamp when the Amazon Q Business application was last updated. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` - // The endpoint URLs for your Amazon Q web experience. The URLs are unique and - // fully hosted by Amazon Web Services. + // The endpoint URLs for your Amazon Q Business web experience. The URLs are + // unique and fully hosted by Amazon Web Services. DefaultEndpoint *string `locationName:"defaultEndpoint" min:"1" type:"string"` - // The status of your Amazon Q web experience. + // The status of your Amazon Q Business web experience. Status *string `locationName:"status" type:"string" enum:"WebExperienceStatus"` - // The Unix timestamp when your Amazon Q web experience was updated. + // The Unix timestamp when your Amazon Q Business web experience was updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"` - // The identifier of your Amazon Q web experience. + // The identifier of your Amazon Q Business web experience. WebExperienceId *string `locationName:"webExperienceId" min:"36" type:"string"` } @@ -19209,12 +19526,12 @@ func (s *WebExperience) SetWebExperienceId(v string) *WebExperience { } // Provides the authorization configuration information needed to deploy a Amazon -// Q web experience to end users. +// Q Business web experience to end users. type WebExperienceAuthConfiguration struct { _ struct{} `type:"structure"` // Provides the SAML 2.0 compliant identity provider (IdP) configuration information - // Amazon Q needs to deploy a Amazon Q web experience. + // Amazon Q Business needs to deploy a Amazon Q Business web experience. SamlConfiguration *SamlConfiguration `locationName:"samlConfiguration" type:"structure"` } @@ -19377,6 +19694,26 @@ func AttributeValueOperator_Values() []string { } } +const ( + // ChatModeRetrievalMode is a ChatMode enum value + ChatModeRetrievalMode = "RETRIEVAL_MODE" + + // ChatModeCreatorMode is a ChatMode enum value + ChatModeCreatorMode = "CREATOR_MODE" + + // ChatModePluginMode is a ChatMode enum value + ChatModePluginMode = "PLUGIN_MODE" +) + +// ChatMode_Values returns all elements of the ChatMode enum +func ChatMode_Values() []string { + return []string{ + ChatModeRetrievalMode, + ChatModeCreatorMode, + ChatModePluginMode, + } +} + const ( // ContentTypePdf is a ContentType enum value ContentTypePdf = "PDF" @@ -19433,6 +19770,22 @@ func ContentType_Values() []string { } } +const ( + // CreatorModeControlEnabled is a CreatorModeControl enum value + CreatorModeControlEnabled = "ENABLED" + + // CreatorModeControlDisabled is a CreatorModeControl enum value + CreatorModeControlDisabled = "DISABLED" +) + +// CreatorModeControl_Values returns all elements of the CreatorModeControl enum +func CreatorModeControl_Values() []string { + return []string{ + CreatorModeControlEnabled, + CreatorModeControlDisabled, + } +} + const ( // DataSourceStatusPendingCreation is a DataSourceStatus enum value DataSourceStatusPendingCreation = "PENDING_CREATION" diff --git a/service/qbusiness/doc.go b/service/qbusiness/doc.go index 5236888dad6..fa07bb346dd 100644 --- a/service/qbusiness/doc.go +++ b/service/qbusiness/doc.go @@ -5,23 +5,23 @@ // // 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 +// 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 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html). +// 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 (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html). // -// For an overview of the Amazon Q APIs, see Overview of Amazon Q API operations -// (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview). +// For an overview of the Amazon Q Business APIs, see Overview of Amazon Q Business +// API operations (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview). // // For information about the IAM access control permissions you need to use -// this API, see IAM roles for Amazon Q (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html) -// in the Amazon Q (for business use) Developer Guide. +// this API, see IAM roles for Amazon Q Business (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html) +// in the Amazon Q Business User Guide. // -// You can use the following AWS SDKs to access Amazon Q APIs: +// You can use the following AWS SDKs to access Amazon Q Business APIs: // // - AWS SDK for C++ (https://docs.aws.amazon.com/sdk-for-cpp) // @@ -38,11 +38,11 @@ // - AWS SDK for Ruby (https://docs.aws.amazon.com/sdk-for-ruby) // // The following resources provide additional information about using the Amazon -// Q API: +// Q Business API: // -// - Setting up for Amazon Q (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html) +// - Setting up for Amazon Q Business (https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html) // -// - Amazon Q CLI Reference (https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html) +// - Amazon Q Business CLI Reference (https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html) // // - Amazon Web Services General Reference (https://docs.aws.amazon.com/general/latest/gr/amazonq.html) // diff --git a/service/qbusiness/errors.go b/service/qbusiness/errors.go index c93038e116a..158736a8cdc 100644 --- a/service/qbusiness/errors.go +++ b/service/qbusiness/errors.go @@ -25,8 +25,8 @@ const ( // ErrCodeInternalServerException for service response error code // "InternalServerException". // - // An issue occurred with the internal server used for your Amazon Q service. - // Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) + // An issue occurred with the internal server used for your Amazon Q Business + // service. Wait some minutes and try again, or contact Support (http://aws.amazon.com/contact-us/) // for help. ErrCodeInternalServerException = "InternalServerException" @@ -48,7 +48,7 @@ const ( // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // - // You have exceeded the set limits for your Amazon Q service. + // You have exceeded the set limits for your Amazon Q Business service. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code @@ -61,8 +61,8 @@ const ( // ErrCodeValidationException for service response error code // "ValidationException". // - // The input doesn't meet the constraints set by the Amazon Q service. Provide - // the correct input and try again. + // The input doesn't meet the constraints set by the Amazon Q Business service. + // Provide the correct input and try again. ErrCodeValidationException = "ValidationException" )