Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"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":{ "name":"CancelSpotFleetRequests", @@ -444,7 +444,7 @@ }, "input":{"shape":"CreateCapacityReservationRequest"}, "output":{"shape":"CreateCapacityReservationResult"}, - "documentation":"Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Creates a new Capacity Reservation with the specified attributes.
Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.
Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.
Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.
" }, "CreateCarrierGateway":{ "name":"CreateCarrierGateway", @@ -534,7 +534,7 @@ }, "input":{"shape":"CreateFleetRequest"}, "output":{"shape":"CreateFleetResult"}, - "documentation":"Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon EC2 User Guide.
" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", @@ -713,7 +713,7 @@ }, "input":{"shape":"CreatePlacementGroupRequest"}, "output":{"shape":"CreatePlacementGroupResult"}, - "documentation":"Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.
A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.
For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", @@ -723,7 +723,7 @@ }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, - "documentation":"Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
" }, "CreateRoute":{ "name":"CreateRoute", @@ -1089,7 +1089,7 @@ }, "input":{"shape":"DeleteFleetsRequest"}, "output":{"shape":"DeleteFleetsResult"}, - "documentation":"Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also 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 Deleting an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances.
You must specify whether a deleted EC2 Fleet should also 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 Deleting an EC2 Fleet in the Amazon EC2 User Guide.
" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", @@ -1253,7 +1253,7 @@ "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, - "documentation":"Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "DeleteQueuedReservedInstances":{ "name":"DeleteQueuedReservedInstances", @@ -1830,7 +1830,7 @@ }, "input":{"shape":"DescribeFleetHistoryRequest"}, "output":{"shape":"DescribeFleetHistoryResult"}, - "documentation":"Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
" + "documentation":"Describes the events for the specified EC2 Fleet during the specified time.
EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
" }, "DescribeFleetInstances":{ "name":"DescribeFleetInstances", @@ -1840,7 +1840,7 @@ }, "input":{"shape":"DescribeFleetInstancesRequest"}, "output":{"shape":"DescribeFleetInstancesResult"}, - "documentation":"Describes the running instances for the specified EC2 Fleet.
" + "documentation":"Describes the running instances for the specified EC2 Fleet.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
" }, "DescribeFleets":{ "name":"DescribeFleets", @@ -1850,7 +1850,7 @@ }, "input":{"shape":"DescribeFleetsRequest"}, "output":{"shape":"DescribeFleetsResult"}, - "documentation":"Describes the specified EC2 Fleets or all of your EC2 Fleets.
" + "documentation":"Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitoring your EC2 Fleet in the Amazon EC2 User Guide.
" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", @@ -1890,7 +1890,7 @@ }, "input":{"shape":"DescribeHostReservationOfferingsRequest"}, "output":{"shape":"DescribeHostReservationOfferingsResult"}, - "documentation":"Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
" }, "DescribeHostReservations":{ "name":"DescribeHostReservations", @@ -2000,7 +2000,7 @@ }, "input":{"shape":"DescribeInstanceCreditSpecificationsRequest"}, "output":{"shape":"DescribeInstanceCreditSpecificationsResult"}, - "documentation":"Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.
If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.
Recently terminated instances might appear in the returned results. This interval is usually less than one hour.
If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "DescribeInstanceEventNotificationAttributes":{ "name":"DescribeInstanceEventNotificationAttributes", @@ -2020,7 +2020,7 @@ }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, - "documentation":"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 Troubleshooting instances with failed status checks in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
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 Troubleshooting 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.
Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.
" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", @@ -2310,7 +2310,7 @@ }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, - "documentation":"Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes one or more of the Reserved Instances that you purchased.
For more information about Reserved Instances, see Reserved Instances in the Amazon EC2 User Guide.
" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", @@ -2320,7 +2320,7 @@ }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, - "documentation":"Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", @@ -2330,7 +2330,7 @@ }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, - "documentation":"Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", @@ -2340,7 +2340,7 @@ }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, - "documentation":"Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", @@ -3132,7 +3132,7 @@ }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, - "documentation":"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 Elastic Compute Cloud User Guide.
" + "documentation":"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":{ "name":"GetConsoleScreenshot", @@ -3152,7 +3152,7 @@ }, "input":{"shape":"GetDefaultCreditSpecificationRequest"}, "output":{"shape":"GetDefaultCreditSpecificationResult"}, - "documentation":"Describes the default credit option for CPU usage of a burstable performance instance family.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"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":{ "name":"GetEbsDefaultKmsKeyId", @@ -3232,7 +3232,7 @@ }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, - "documentation":"Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon Elastic Compute Cloud User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
" + "documentation":"Retrieves the encrypted administrator password for a running Windows instance.
The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon EC2 User Guide.
For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.
The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.
When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.
" }, "GetReservedInstancesExchangeQuote":{ "name":"GetReservedInstancesExchangeQuote", @@ -3392,7 +3392,7 @@ }, "input":{"shape":"ModifyDefaultCreditSpecificationRequest"}, "output":{"shape":"ModifyDefaultCreditSpecificationResult"}, - "documentation":"Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.
ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "ModifyEbsDefaultKmsKeyId":{ "name":"ModifyEbsDefaultKmsKeyId", @@ -3468,7 +3468,7 @@ "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, - "documentation":"Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.
Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.
To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon EC2 User Guide.
" }, "ModifyInstanceCapacityReservationAttributes":{ "name":"ModifyInstanceCapacityReservationAttributes", @@ -3488,7 +3488,7 @@ }, "input":{"shape":"ModifyInstanceCreditSpecificationRequest"}, "output":{"shape":"ModifyInstanceCreditSpecificationResult"}, - "documentation":"Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.
For more information, see Burstable performance instances in the Amazon EC2 User Guide.
" }, "ModifyInstanceEventStartTime":{ "name":"ModifyInstanceEventStartTime", @@ -3508,7 +3508,7 @@ }, "input":{"shape":"ModifyInstanceMetadataOptionsRequest"}, "output":{"shape":"ModifyInstanceMetadataOptionsResult"}, - "documentation":"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.
" + "documentation":"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":{ "name":"ModifyInstancePlacement", @@ -3557,7 +3557,7 @@ }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, - "documentation":"Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", @@ -3783,7 +3783,7 @@ }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, - "documentation":"Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon Elastic Compute Cloud User Guide.
To disable detailed monitoring, see .
" + "documentation":"Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
To disable detailed monitoring, see .
" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", @@ -3823,7 +3823,7 @@ }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, - "documentation":"Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
" }, "PurchaseScheduledInstances":{ "name":"PurchaseScheduledInstances", @@ -3842,7 +3842,7 @@ "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, - "documentation":"Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.
If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon EC2 User Guide.
" }, "RegisterImage":{ "name":"RegisterImage", @@ -4076,7 +4076,7 @@ "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, - "documentation":"Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.
The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon VPC User Guide.
Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don't specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don't specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", @@ -4164,7 +4164,7 @@ }, "input":{"shape":"RunScheduledInstancesRequest"}, "output":{"shape":"RunScheduledInstancesResult"}, - "documentation":"Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
" }, "SearchLocalGatewayRoutes":{ "name":"SearchLocalGatewayRoutes", @@ -4213,7 +4213,7 @@ }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, - "documentation":"Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Starts an Amazon EBS-backed instance that you've previously stopped.
Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.
Performing this operation on an instance that uses an instance store as its root device returns an error.
For more information, see Stopping instances in the Amazon EC2 User Guide.
" }, "StartNetworkInsightsAnalysis":{ "name":"StartNetworkInsightsAnalysis", @@ -4243,7 +4243,7 @@ }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, - "documentation":"Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Stops an Amazon EBS-backed instance.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon EC2 User Guide.
" }, "TerminateClientVpnConnections":{ "name":"TerminateClientVpnConnections", @@ -4263,7 +4263,7 @@ }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, - "documentation":"Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
" }, "UnassignIpv6Addresses":{ "name":"UnassignIpv6Addresses", @@ -4292,7 +4292,7 @@ }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, - "documentation":"Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
" }, "UpdateSecurityGroupRuleDescriptionsEgress":{ "name":"UpdateSecurityGroupRuleDescriptionsEgress", @@ -4593,7 +4593,7 @@ "AddPrefixListEntries":{ "type":"list", "member":{"shape":"AddPrefixListEntry"}, - "max":1000, + "max":100, "min":0 }, "AddPrefixListEntry":{ @@ -4814,7 +4814,7 @@ "members":{ "AutoPlacement":{ "shape":"AutoPlacement", - "documentation":"Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
Default: on
Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName":"clientToken" }, "InstanceType":{ @@ -4848,7 +4848,7 @@ }, "HostRecovery":{ "shape":"HostRecovery", - "documentation":"Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.
Default: off
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.
Default: off
Suppresses the specified device included in the block device mapping of the AMI.
", + "documentation":"To omit the device from the block device mapping, specify an empty string.
", "locationName":"noDevice" } }, @@ -6987,9 +6987,14 @@ }, "State":{ "shape":"CapacityReservationState", - "documentation":"The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
The date and time at which the Capacity Reservation was started.
", + "locationName":"startDate" + }, "EndDate":{ "shape":"DateTime", "documentation":"The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon Elastic Compute Cloud User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
" }, "CapacityReservationOptionsRequest":{ "type":"structure", @@ -7084,7 +7089,7 @@ "documentation":"Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price or prioritized).
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
" } }, - "documentation":"Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon Elastic Compute Cloud User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
This strategy can only be used if the EC2 Fleet is of type instant.
For more information about Capacity Reservations, see On-Demand Capacity Reservations in the Amazon EC2 User Guide. For examples of using Capacity Reservations in an EC2 Fleet, see EC2 Fleet example configurations in the Amazon EC2 User Guide.
" }, "CapacityReservationPreference":{ "type":"string", @@ -8412,11 +8417,11 @@ "members":{ "ClientToken":{ "shape":"String", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
" + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
" }, "InstanceType":{ "shape":"String", - "documentation":"The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
" }, "InstancePlatform":{ "shape":"CapacityReservationInstancePlatform", @@ -8932,7 +8937,7 @@ }, "Type":{ "shape":"FleetType", - "documentation":"The type of request. The default value is maintain.
maintain - The EC2 Fleet plaees an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The type of request. The default value is maintain.
maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.
For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.
" }, "ValidFrom":{ "shape":"DateTime", @@ -13193,7 +13198,7 @@ }, "Filters":{ "shape":"FilterList", - "documentation":"One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the AWS account that owns the Capacity Reservation.
availability-zone-id - The Availability Zone ID of the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone ID of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the AWS account that owns the Capacity Reservation.
availability-zone-id - The Availability Zone ID of the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone ID of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
The instance types. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName":"InstanceType" }, "Filters":{ @@ -14899,7 +14904,7 @@ "members":{ "InstanceTypes":{ "shape":"InstanceTypeInfoList", - "documentation":"The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName":"instanceTypeSet" }, "NextToken":{ @@ -16149,7 +16154,7 @@ }, "InstanceType":{ "shape":"InstanceType", - "documentation":"The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
", "locationName":"deleteOnTermination" }, "Iops":{ @@ -19156,12 +19161,12 @@ }, "VolumeSize":{ "shape":"Integer", - "documentation":"The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1: 500-16,384
sc1: 500-16,384
standard: 1-1,024
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The volume type. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.
The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
", + "documentation":"Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by .
", "locationName":"encrypted" } }, @@ -19193,7 +19198,7 @@ "members":{ "EbsOptimizedSupport":{ "shape":"EbsOptimizedSupport", - "documentation":"Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-Optimized Instances in Amazon EC2 User Guide for Linux Instances.
", + "documentation":"Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.
", "locationName":"ebsOptimizedSupport" }, "EncryptionSupport":{ @@ -21014,7 +21019,7 @@ "documentation":"The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
Describes the Amazon EC2 launch template and the launch template version that can be used by an EC2 Fleet to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the Amazon EC2 launch template and the launch template version that can be used by an EC2 Fleet to configure Amazon EC2 instances. For information about launch templates, see Launching an instance from a launch template in the Amazon EC2 User Guide.
" }, "FleetOnDemandAllocationStrategy":{ "type":"string", @@ -21053,7 +21058,7 @@ "documentation":"The replacement strategy to use. Only available for fleets of type maintain.
To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance notification is emitted for an existing Spot Instance in the fleet, specify launch. You must specify a value, otherwise you get an error.
When a replacement instance is launched, the instance marked for rebalance is not automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide.
" }, "FleetSpotMaintenanceStrategies":{ "type":"structure", @@ -21550,7 +21555,7 @@ }, "State":{ "shape":"CapacityReservationState", - "documentation":"The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active - The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
" }, "HibernationOptionsRequest":{ "type":"structure", @@ -22383,7 +22388,7 @@ "documentation":"If you set this parameter to true, your instance is enabled for hibernation.
Default: false
Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
" }, "HistoryRecord":{ "type":"structure", @@ -22461,7 +22466,7 @@ }, "ClientToken":{ "shape":"String", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName":"clientToken" }, "HostId":{ @@ -22511,7 +22516,7 @@ }, "AllowsMultipleInstanceTypes":{ "shape":"AllowsMultipleInstanceTypes", - "documentation":"Indicates whether the Dedicated Host supports multiple instance types of the same instance family, or a specific instance type only. one indicates that the Dedicated Host supports multiple instance types in the instance family. off indicates that the Dedicated Host supports a single instance type only.
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.
Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. 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 NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.
Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. 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 NAT. For more information, see NAT instances in the Amazon VPC User Guide.
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName":"instanceType" }, "CurrentGeneration":{ @@ -25750,7 +25755,7 @@ "members":{ "InstanceType":{ "shape":"InstanceType", - "documentation":"The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", "locationName":"instanceType" }, "LocationType":{ @@ -28070,6 +28075,10 @@ "shape":"EndDateType", "documentation":"Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
Reserved. Capacity Reservations you have created are accepted by default.
" + }, "DryRun":{ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.
" }, "InstanceType":{ "shape":"String", @@ -28453,7 +28462,7 @@ }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", - "documentation":"Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon Elastic Compute Cloud User Guide.
", + "documentation":"Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide.
", "locationName":"blockDeviceMapping" }, "DisableApiTermination":{ @@ -28493,7 +28502,7 @@ }, "InstanceType":{ "shape":"AttributeValue", - "documentation":"Changes the instance type to the specified value. For more information, see Instance types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
" + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", @@ -32265,7 +32274,7 @@ "members":{ "ClientToken":{ "shape":"String", - "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", + "documentation":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
", "locationName":"clientToken" }, "CurrencyCode":{ @@ -32869,7 +32878,7 @@ "RemovePrefixListEntries":{ "type":"list", "member":{"shape":"RemovePrefixListEntry"}, - "max":1000, + "max":100, "min":0 }, "RemovePrefixListEntry":{ @@ -35026,7 +35035,7 @@ }, "InstanceType":{ "shape":"InstanceType", - "documentation":"The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
Default: m1.small
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.
" }, "ElasticInferenceAccelerators":{ "shape":"ElasticInferenceAccelerators", @@ -35153,11 +35162,11 @@ }, "CreditSpecification":{ "shape":"CreditSpecificationRequest", - "documentation":"The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a instances)
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a instances)
The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon EC2 User Guide.
" }, "CapacityReservationSpecification":{ "shape":"CapacityReservationSpecification", @@ -35165,7 +35174,7 @@ }, "HibernationOptions":{ "shape":"HibernationOptionsRequest", - "documentation":"Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
" + "documentation":"Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can't enable hibernation and AWS Nitro Enclaves on the same instance.
" }, "LicenseSpecifications":{ "shape":"LicenseSpecificationListRequest", @@ -35499,7 +35508,7 @@ }, "NoDevice":{ "shape":"String", - "documentation":"Suppresses the specified device included in the block device mapping of the AMI.
" + "documentation":"To omit the device from the block device mapping, specify an empty string.
" }, "VirtualName":{ "shape":"String", @@ -35528,7 +35537,7 @@ }, "Iops":{ "shape":"Integer", - "documentation":"The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.
The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when the instance interruption behavior is either hibernate or stop.
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.
Default: false
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.
One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
This API action only supports filtering documents by using a single tag key and one or more tag values. For example: Key=tag:tagName,Values=valueName1,valueName2
The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
", + "documentation":"The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
", "box":true }, "ExecutionRoleName":{ From 00260c69679db5f91e06d7a627b24fe224d807b3 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:12:50 +0000 Subject: [PATCH 4/9] AWS IoT Greengrass V2 Update: Documentation updates that improve clarity and fix broken links. --- .../feature-AWSIoTGreengrassV2-691896e.json | 6 ++++ .../codegen-resources/service-2.json | 32 +++++++++---------- 2 files changed, 22 insertions(+), 16 deletions(-) create mode 100644 .changes/next-release/feature-AWSIoTGreengrassV2-691896e.json diff --git a/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json b/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json new file mode 100644 index 000000000000..076f17032dfb --- /dev/null +++ b/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS IoT Greengrass V2", + "contributor": "", + "description": "Documentation updates that improve clarity and fix broken links." +} diff --git a/services/greengrassv2/src/main/resources/codegen-resources/service-2.json b/services/greengrassv2/src/main/resources/codegen-resources/service-2.json index 3461e8942228..1bb942cc13c3 100644 --- a/services/greengrassv2/src/main/resources/codegen-resources/service-2.json +++ b/services/greengrassv2/src/main/resources/codegen-resources/service-2.json @@ -65,7 +65,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"Creates a continuous deployment for a target, which is a AWS IoT Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, AWS IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. AWS IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.
For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
" }, "DeleteComponent":{ "name":"DeleteComponent", @@ -152,7 +152,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Gets the pre-signed URL to a component artifact in an S3 bucket. Core devices can call this operation to identify the URL that they can use to download an artifact to install.
" + "documentation":"Gets the pre-signed URL to download a public component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.
" }, "GetCoreDevice":{ "name":"GetCoreDevice", @@ -318,7 +318,7 @@ {"shape":"InternalServerException"}, {"shape":"ConflictException"} ], - "documentation":"Retrieves a list of components that meet the component, version, and platform requirements of a deployment. AWS IoT Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.
Retrieves a list of components that meet the component, version, and platform requirements of a deployment. AWS IoT Greengrass core devices call this operation when they receive a deployment to identify the components to install.
This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component A requires version >2.0.0 and component B requires version <2.0.0 of a component dependency.
When you specify the component candidates to resolve, AWS IoT Greengrass compares each component's digest from the core device with the component's digest in the AWS Cloud. If the digests don't match, then AWS IoT Greengrass specifies to use the version from the AWS Cloud.
To use this operation, you must use the data plane API endpoint and authenticate with an AWS IoT device certificate. For more information, see AWS IoT Greengrass endpoints and quotas.
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -784,7 +784,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -878,7 +878,7 @@ }, "action":{ "shape":"DeploymentComponentUpdatePolicyAction", - "documentation":"Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
Whether or not to notify components and wait for components to become safe to update. Choose from the following options:
NOTIFY_COMPONENTS – The deployment notifies each component before it stops and updates that component. Components can use the SubscribeToComponentUpdates IPC operation to receive these notifications. Then, components can respond with the DeferComponentUpdate IPC operation. For more information, see Create deployments in the AWS IoT Greengrass V2 Developer Guide.
SKIP_NOTIFY_COMPONENTS – The deployment doesn't notify components or wait for them to be safe to update.
Default: NOTIFY_COMPONENTS
Contains information about a deployment's policy that defines when components are safe to update.
Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.
" @@ -899,7 +899,7 @@ "box":true } }, - "documentation":"Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see the Create deployments in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the SubscribeToValidateConfigurationUpdates IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the SendConfigurationValidityReport IPC operation. For more information, see Create deployments in the AWS IoT Greengrass V2 Developer Guide.
" }, "DeploymentFailureHandlingPolicy":{ "type":"string", @@ -1016,7 +1016,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -1141,7 +1141,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -1154,13 +1154,13 @@ "members":{ "arn":{ "shape":"ComponentVersionARN", - "documentation":"The ARN of the component version.
", + "documentation":"The ARN of the component version. Specify the ARN of a public component version.
", "location":"uri", "locationName":"arn" }, "artifactName":{ "shape":"NonEmptyString", - "documentation":"The name of the artifact.
", + "documentation":"The name of the artifact.
You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.
The URL to the artifact.
" + "documentation":"The URL of the artifact.
" } } }, @@ -1217,7 +1217,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -1286,7 +1286,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -2020,7 +2020,7 @@ "members":{ "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, @@ -2192,7 +2192,7 @@ }, "tags":{ "shape":"TagMap", - "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" + "documentation":"A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the AWS IoT Greengrass V2 Developer Guide.
" } } }, From 1478a9d05385afa8e81699d867434decb03d1a11 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:12:46 +0000 Subject: [PATCH 5/9] Amazon Lex Runtime V2 Update: This release adds support for Amazon Lex V2 APIs for runtime, including Streaming APIs for conversation management. --- .../feature-AmazonLexRuntimeV2-a823e3d.json | 6 + services/lexruntimev2/pom.xml | 60 + .../codegen-resources/paginators-1.json | 4 + .../codegen-resources/service-2.json | 1436 +++++++++++++++++ 4 files changed, 1506 insertions(+) create mode 100644 .changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json create mode 100644 services/lexruntimev2/pom.xml create mode 100644 services/lexruntimev2/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/lexruntimev2/src/main/resources/codegen-resources/service-2.json diff --git a/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json b/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json new file mode 100644 index 000000000000..6b4ae1844a17 --- /dev/null +++ b/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Lex Runtime V2", + "contributor": "", + "description": "This release adds support for Amazon Lex V2 APIs for runtime, including Streaming APIs for conversation management." +} diff --git a/services/lexruntimev2/pom.xml b/services/lexruntimev2/pom.xml new file mode 100644 index 000000000000..73fd19caccc3 --- /dev/null +++ b/services/lexruntimev2/pom.xml @@ -0,0 +1,60 @@ + + + +Removes session information for a specified bot, alias, and user ID.
You can use this operation to restart a conversation with a bot. When you remove a session, the entire history of the session is removed so that you can start again.
You don't need to delete a session. Sessions have a time limit and will expire. Set the session time limit when you create the bot. The default is 5 minutes, but you can specify anything between 1 minute and 24 hours.
If you specify a bot or alias ID that doesn't exist, you receive a BadRequestException.
If the locale doesn't exist in the bot, or if the locale hasn't been enables for the alias, you receive a BadRequestException.
Returns session information for a specified bot, alias, and user.
For example, you can use this operation to retrieve session information for a user that has left a long-running session in use.
If the bot, alias, or session identifier doesn't exist, Amazon Lex returns a BadRequestException. If the locale doesn't exist or is not enabled for the alias, you receive a BadRequestException.
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
" + }, + "RecognizeText":{ + "name":"RecognizeText", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/text" + }, + "input":{"shape":"RecognizeTextRequest"}, + "output":{"shape":"RecognizeTextResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"} + ], + "documentation":"Sends user input to Amazon Lex. Client applications use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model that it build for the bot.
In response, Amazon Lex returns the next message to convey to the user and an optional response card to display.
" + }, + "RecognizeUtterance":{ + "name":"RecognizeUtterance", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/utterance" + }, + "input":{"shape":"RecognizeUtteranceRequest"}, + "output":{"shape":"RecognizeUtteranceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"} + ], + "documentation":"Sends user input to Amazon Lex. You can send text or speech. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model built for the bot.
", + "authtype":"v4-unsigned-body" + }, + "StartConversation":{ + "name":"StartConversation", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botAliases/{botAliasId}/botLocales/{localeId}/sessions/{sessionId}/conversation" + }, + "input":{"shape":"StartConversationRequest"}, + "output":{"shape":"StartConversationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Starts an HTTP/2 bidirectional event stream that enables you to send audio, text, or DTMF input in real time. After your application starts a conversation, users send input to Amazon Lex as a stream of events. Amazon Lex processes the incoming events and responds with streaming text or audio events.
" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveContext":{ + "type":"structure", + "required":[ + "name", + "timeToLive" + ], + "members":{ + "name":{ + "shape":"ActiveContextName", + "documentation":"The name of the context.
" + }, + "timeToLive":{ + "shape":"ActiveContextTimeToLive", + "documentation":"Indicates the number of turns or seconds that the context is active. Once the time to live expires, the context is no longer returned in a response.
" + }, + "contextAttributes":{ + "shape":"ActiveContextParametersMap", + "documentation":"A lis tof contexts active for the request. A context can be activated when a previous intent is fulfilled, or by including the context in the request.
If you don't specify a list of contexts, Amazon Lex will use the current list of contexts for the session. If you specify an empty list, all contexts for the session are cleared.
" + } + }, + "documentation":"Contains information about the contexts that a user is using in a session. You can configure Amazon Lex to set a context when an intent is fulfilled, or you can set a context using the , , or operations.
Use a context to indicate to Amazon Lex intents that should be used as follow-up intents. For example, if the active context is order-fulfilled, only intents that have order-fulfilled configured as a trigger are considered for follow up.
The number of seconds that the context is active. You can specify between 5 and 86400 seconds (24 hours).
" + }, + "turnsToLive":{ + "shape":"ActiveContextTurnsToLive", + "documentation":"The number of turns that the context is active. You can specify up to 20 turns. Each request and response from the bot is a turn.
" + } + }, + "documentation":"The time that a context is active. You can specify the time to live in seconds or in conversation turns.
" + }, + "ActiveContextTimeToLiveInSeconds":{ + "type":"integer", + "max":86400, + "min":5 + }, + "ActiveContextTurnsToLive":{ + "type":"integer", + "max":20, + "min":1 + }, + "ActiveContextsList":{ + "type":"list", + "member":{"shape":"ActiveContext"}, + "max":20, + "min":0 + }, + "AttachmentTitle":{ + "type":"string", + "max":250, + "min":1 + }, + "AttachmentUrl":{ + "type":"string", + "max":250, + "min":1 + }, + "AudioChunk":{"type":"blob"}, + "AudioInputEvent":{ + "type":"structure", + "required":["contentType"], + "members":{ + "audioChunk":{ + "shape":"AudioChunk", + "documentation":"An encoded stream of audio.
" + }, + "contentType":{ + "shape":"NonEmptyString", + "documentation":"The encoding used for the audio chunk. You must use 8 KHz PCM 16-bit mono-channel little-endian format. The value of the field should be:
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"Represents a chunk of audio sent from the client application to Amazon Lex. The audio is all or part of an utterance from the user.
Amazon Lex accumulates audio chunks until it recognizes a natural pause in speech before processing the input.
", + "event":true + }, + "AudioResponseEvent":{ + "type":"structure", + "members":{ + "audioChunk":{ + "shape":"AudioChunk", + "documentation":"A chunk of the audio to play.
" + }, + "contentType":{ + "shape":"NonEmptyString", + "documentation":"The encoding of the audio chunk. This is the same as the encoding configure in the contentType field of the ConfigurationEvent.
A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
An event sent from Amazon Lex to your client application containing audio to play to the user.
", + "event":true + }, + "BadGatewayException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":502}, + "exception":true + }, + "BlobStream":{ + "type":"blob", + "streaming":true + }, + "Boolean":{"type":"boolean"}, + "BotAliasIdentifier":{"type":"string"}, + "BotIdentifier":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^[0-9a-zA-Z]+$" + }, + "Button":{ + "type":"structure", + "required":[ + "text", + "value" + ], + "members":{ + "text":{ + "shape":"ButtonText", + "documentation":"The text that is displayed on the button.
" + }, + "value":{ + "shape":"ButtonValue", + "documentation":"The value returned to Amazon Lex when a user chooses the button.
" + } + }, + "documentation":"A button that appears on a response card show to the user.
" + }, + "ButtonText":{ + "type":"string", + "max":50, + "min":1 + }, + "ButtonValue":{ + "type":"string", + "max":50, + "min":1 + }, + "ButtonsList":{ + "type":"list", + "member":{"shape":"Button"}, + "max":5, + "min":0 + }, + "ConfidenceScore":{ + "type":"structure", + "members":{ + "score":{ + "shape":"Double", + "documentation":"A score that indicates how confident Amazon Lex is that an intent satisfies the user's intent. Ranges between 0.00 and 1.00. Higher scores indicate higher confidence.
" + } + }, + "documentation":"Provides a score that indicates the confidence that Amazon Lex has that an intent is the one that satisfies the user's intent.
" + }, + "ConfigurationEvent":{ + "type":"structure", + "required":["responseContentType"], + "members":{ + "requestAttributes":{ + "shape":"StringMap", + "documentation":"Request-specific information passed between the client application and Amazon Lex.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.
The message that Amazon Lex returns in the response can be either text or speech based on the responseContentType value.
If the value is text/plain;charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little-endian format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
audio/* (defaults to mpeg)
text/plain; charset=utf-8
A list of messages to send to the user.
" + }, + "disablePlayback":{ + "shape":"Boolean", + "documentation":"Determines whether Amazon Lex should send audio responses to the client application. When this parameter if false, the client application needs to create responses for the user.
A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"The initial event sent from the application to Amazon Lex to configure the conversation, including session and request attributes and the response content type.
", + "event":true + }, + "ConfirmationState":{ + "type":"string", + "enum":[ + "Confirmed", + "Denied", + "None" + ] + }, + "ConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConversationMode":{ + "type":"string", + "enum":[ + "AUDIO", + "TEXT" + ] + }, + "DTMFInputEvent":{ + "type":"structure", + "required":["inputCharacter"], + "members":{ + "inputCharacter":{ + "shape":"DTMFRegex", + "documentation":"The DTMF character that the user pressed. The allowed characters are A - D, 0 - 9, # and *.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"A DTMF character sent from the client application. DTMF characters are typically sent from a phone keypad to represent numbers. For example, you can have Amazon Lex process a credit card number input from a phone.
", + "event":true + }, + "DTMFRegex":{ + "type":"string", + "max":1, + "min":1, + "pattern":"^[A-D0-9#*]{1}$", + "sensitive":true + }, + "DeleteSessionRequest":{ + "type":"structure", + "required":[ + "botId", + "botAliasId", + "sessionId", + "localeId" + ], + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot that contains the session data.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that contains the session data.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session to delete.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "DeleteSessionResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot that contained the session data.
" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that contained the session data.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session was used.
" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the deleted session.
" + } + } + }, + "DependencyFailedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":424}, + "exception":true + }, + "DialogAction":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"DialogActionType", + "documentation":"The next action that the bot should take in its interaction with the user. The possible values are:
Close - Indicates that there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.
ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"
Delegate - The next action is determined by Amazon Lex.
ElicitSlot - The next action is to elicit a slot value from the user.
The name of the slot that should be elicited from the user.
" + } + }, + "documentation":"The next action that Amazon Lex should take.
" + }, + "DialogActionType":{ + "type":"string", + "enum":[ + "Close", + "ConfirmIntent", + "Delegate", + "ElicitIntent", + "ElicitSlot" + ] + }, + "DisconnectionEvent":{ + "type":"structure", + "members":{ + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"A notification from the client that it is disconnecting from Amazon Lex. Sending a DisconnectionEvent event is optional, but can help identify a conversation in logs.
The identifier of the bot that contains the session data.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that contains the session data.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session to return.
", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "sessionId":{ + "shape":"NonEmptyString", + "documentation":"The identifier of the returned session.
" + }, + "messages":{ + "shape":"Messages", + "documentation":"A list of messages that were last sent to the user. The messages are ordered based on the order that your returned the messages from your Lambda function or the order that messages are defined in the bot.
" + }, + "interpretations":{ + "shape":"Interpretations", + "documentation":"A list of intents that Amazon Lex determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
" + }, + "sessionState":{ + "shape":"SessionState", + "documentation":"Represents the current state of the dialog between the user and the bot.
You can use this to determine the progress of the conversation and what the next action might be.
" + } + } + }, + "HeartbeatEvent":{ + "type":"structure", + "members":{ + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
Event that Amazon Lex sends to indicate that the stream is still open between the client application and Amazon Lex
", + "event":true + }, + "ImageResponseCard":{ + "type":"structure", + "required":["title"], + "members":{ + "title":{ + "shape":"AttachmentTitle", + "documentation":"The title to display on the response card. The format of the title is determined by the platform displaying the response card.
" + }, + "subtitle":{ + "shape":"AttachmentTitle", + "documentation":"The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
" + }, + "imageUrl":{ + "shape":"AttachmentUrl", + "documentation":"The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
" + }, + "buttons":{ + "shape":"ButtonsList", + "documentation":"A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
" + } + }, + "documentation":"A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
" + }, + "InputMode":{ + "type":"string", + "enum":[ + "Text", + "Speech", + "DTMF" + ] + }, + "Intent":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"The name of the intent.
" + }, + "slots":{ + "shape":"Slots", + "documentation":"A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.
" + }, + "state":{ + "shape":"IntentState", + "documentation":"Contains fulfillment information for the intent.
" + }, + "confirmationState":{ + "shape":"ConfirmationState", + "documentation":"Contains information about whether fulfillment of the intent has been confirmed.
" + } + }, + "documentation":"The current intent that Amazon Lex is attempting to fulfill.
" + }, + "IntentResultEvent":{ + "type":"structure", + "members":{ + "inputMode":{ + "shape":"InputMode", + "documentation":"Indicates whether the input to the operation was text or speech.
" + }, + "interpretations":{ + "shape":"Interpretations", + "documentation":"A list of intents that Amazon Lex determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
" + }, + "sessionState":{"shape":"SessionState"}, + "requestAttributes":{ + "shape":"StringMap", + "documentation":"The attributes sent in the request.
" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session in use.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
Contains the current state of the conversation between the client application and Amazon Lex.
", + "event":true + }, + "IntentState":{ + "type":"string", + "enum":[ + "Failed", + "Fulfilled", + "InProgress", + "ReadyForFulfillment", + "Waiting" + ] + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "Interpretation":{ + "type":"structure", + "members":{ + "nluConfidence":{ + "shape":"ConfidenceScore", + "documentation":"Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a response. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
The sentiment expressed in an utterance.
When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains the result of the analysis.
" + }, + "intent":{ + "shape":"Intent", + "documentation":"A list of intents that might satisfy the user's utterance. The intents are ordered by the confidence score.
" + } + }, + "documentation":"An intent that Amazon Lex determined might satisfy the user's utterance. The intents are ordered by the confidence score.
" + }, + "Interpretations":{ + "type":"list", + "member":{"shape":"Interpretation"}, + "max":5 + }, + "LocaleId":{ + "type":"string", + "min":1 + }, + "Message":{ + "type":"structure", + "members":{ + "content":{ + "shape":"Text", + "documentation":"The text of the message.
" + }, + "contentType":{ + "shape":"MessageContentType", + "documentation":"Indicates the type of response.
" + }, + "imageResponseCard":{"shape":"ImageResponseCard"} + }, + "documentation":"Container for text that is returned to the customer..
" + }, + "MessageContentType":{ + "type":"string", + "enum":[ + "CustomPayload", + "ImageResponseCard", + "PlainText", + "SSML" + ] + }, + "Messages":{ + "type":"list", + "member":{"shape":"Message"}, + "max":10 + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "ParameterName":{ + "type":"string", + "max":100, + "min":1 + }, + "PlaybackCompletionEvent":{ + "type":"structure", + "members":{ + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"Event sent from the client application to Amazon Lex to indicate that playback of audio is complete and that Amazon Lex should start processing the user's input.
", + "event":true + }, + "PlaybackInterruptionEvent":{ + "type":"structure", + "members":{ + "eventReason":{ + "shape":"PlaybackInterruptionReason", + "documentation":"Indicates the type of user input that Amazon Lex detected.
" + }, + "causedByEventId":{ + "shape":"EventId", + "documentation":"The identifier of the event that contained the audio, DTMF, or text that caused the interruption.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
Event sent from Amazon Lex to indicate to the client application should stop playback of audio. For example, if the client is playing a prompt that asks for the user's telephone number, the user might start to say the phone number before the prompt is complete. Amazon Lex sends this event to the client application to indicate that the user is responding and that Amazon Lex is processing their input.
", + "event":true + }, + "PlaybackInterruptionReason":{ + "type":"string", + "enum":[ + "DTMF_START_DETECTED", + "TEXT_DETECTED", + "VOICE_START_DETECTED" + ] + }, + "PutSessionRequest":{ + "type":"structure", + "required":[ + "botId", + "botAliasId", + "localeId", + "sessionState", + "sessionId" + ], + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot that receives the session data.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier of the bot that receives the session data.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session that receives the session data.
", + "location":"uri", + "locationName":"sessionId" + }, + "messages":{ + "shape":"Messages", + "documentation":"A list of messages to send to the user. Messages are sent in the order that they are defined in the list.
" + }, + "sessionState":{ + "shape":"SessionState", + "documentation":"Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex should use in the conversation with the user.
" + }, + "requestAttributes":{ + "shape":"StringMap", + "documentation":"Request-specific information passed between Amazon Lex and the client application.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
The message that Amazon Lex returns in the response can be either text or speech depending on the value of this parameter.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
The type of response. Same as the type specified in the responseContentType field in the request.
A list of messages that were last sent to the user. The messages are ordered based on how you return the messages from you Lambda function or the order that the messages are defined in the bot.
", + "location":"header", + "locationName":"x-amz-lex-messages" + }, + "sessionState":{ + "shape":"NonEmptyString", + "documentation":"Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action may be.
", + "location":"header", + "locationName":"x-amz-lex-session-state" + }, + "requestAttributes":{ + "shape":"NonEmptyString", + "documentation":"Request-specific information passed between the client application and Amazon Lex. These are the same as the requestAttribute parameter in the call to the PutSession operation.
The identifier of the session that received the data.
", + "location":"header", + "locationName":"x-amz-lex-session-id" + }, + "audioStream":{ + "shape":"BlobStream", + "documentation":"If the requested content type was audio, the audio version of the message to convey to the user.
" + } + }, + "payload":"audioStream" + }, + "RecognizeTextRequest":{ + "type":"structure", + "required":[ + "botId", + "botAliasId", + "localeId", + "text", + "sessionId" + ], + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot that processes the request.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that processes the request.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the user session that is having the conversation.
", + "location":"uri", + "locationName":"sessionId" + }, + "text":{ + "shape":"Text", + "documentation":"The text that the user entered. Amazon Lex interprets this text.
" + }, + "sessionState":{ + "shape":"SessionState", + "documentation":"The current state of the dialog between the user and the bot.
" + }, + "requestAttributes":{ + "shape":"StringMap", + "documentation":"Request-specific information passed between the client application and Amazon Lex
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
A list of messages last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
" + }, + "sessionState":{ + "shape":"SessionState", + "documentation":"Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action may be.
" + }, + "interpretations":{ + "shape":"Interpretations", + "documentation":"A list of intents that Amazon Lex determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates now confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
" + }, + "requestAttributes":{ + "shape":"StringMap", + "documentation":"The attributes sent in the request.
" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session in use.
" + } + } + }, + "RecognizeUtteranceRequest":{ + "type":"structure", + "required":[ + "botId", + "botAliasId", + "localeId", + "requestContentType", + "sessionId" + ], + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot that should receive the request.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that should receive the request.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session in use.
", + "location":"uri", + "locationName":"sessionId" + }, + "sessionState":{ + "shape":"SensitiveNonEmptyString", + "documentation":"Sets the state of the session with the user. You can use this to set the current intent, attributes, context, and dialog action. Use the dialog action to determine the next step that Amazon Lex should use in the conversation with the user.
", + "location":"header", + "locationName":"x-amz-lex-session-state" + }, + "requestAttributes":{ + "shape":"SensitiveNonEmptyString", + "documentation":"Request-specific information passed between the client application and Amazon Lex
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes for prefix x-amz-lex:.
Indicates the format for audio input or that the content is text. The header must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble;preamble-size=0;bit-rate=256000;frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
The message that Amazon Lex returns in the response can be either text or speech based on the responseContentType value.
If the value is text/plain;charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech using the configuration that you specified in the requestContentType parameter. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
If the value is audio/pcm, the speech returned is audio/pcm at 16 KHz in 16-bit, little-endian format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm (16 KHz)
audio/* (defaults to mpeg)
text/plain; charset=utf-8
User input in PCM or Opus audio format or text format as described in the requestContentType parameter.
Indicates whether the input mode to the operation was text or speech.
", + "location":"header", + "locationName":"x-amz-lex-input-mode" + }, + "contentType":{ + "shape":"NonEmptyString", + "documentation":"Content type as specified in the responseContentType in the request.
A list of messages that were last sent to the user. The messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
", + "location":"header", + "locationName":"x-amz-lex-messages" + }, + "interpretations":{ + "shape":"NonEmptyString", + "documentation":"A list of intents that Amazon Lex determined might satisfy the user's utterance.
Each interpretation includes the intent, a score that indicates how confident Amazon Lex is that the interpretation is the correct one, and an optional sentiment response that indicates the sentiment expressed in the utterance.
", + "location":"header", + "locationName":"x-amz-lex-interpretations" + }, + "sessionState":{ + "shape":"NonEmptyString", + "documentation":"Represents the current state of the dialog between the user and the bot.
Use this to determine the progress of the conversation and what the next action might be.
", + "location":"header", + "locationName":"x-amz-lex-session-state" + }, + "requestAttributes":{ + "shape":"NonEmptyString", + "documentation":"The attributes sent in the request.
", + "location":"header", + "locationName":"x-amz-lex-request-attributes" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the session in use.
", + "location":"header", + "locationName":"x-amz-lex-session-id" + }, + "inputTranscript":{ + "shape":"NonEmptyString", + "documentation":"The text used to process the request.
If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.
The prompt or statement to send to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.
The overall sentiment expressed in the user's response. This is the sentiment most likely expressed by the user based on the analysis by Amazon Comprehend.
" + }, + "sentimentScore":{"shape":"SentimentScore"} + }, + "documentation":"Provides information about the sentiment expressed in a user's response in a conversation. Sentiments are determined using Amazon Comprehend. Sentiments are only returned if they are enabled for the bot.
For more information, see Determine Sentiment in the Amazon Comprehend developer guide.
" + }, + "SentimentScore":{ + "type":"structure", + "members":{ + "positive":{ + "shape":"Double", + "documentation":"The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.
The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.
The individual sentiment responses for the utterance.
" + }, + "SentimentType":{ + "type":"string", + "enum":[ + "MIXED", + "NEGATIVE", + "NEUTRAL", + "POSITIVE" + ] + }, + "SessionId":{ + "type":"string", + "max":100, + "min":2, + "pattern":"[0-9a-zA-Z._:-]+" + }, + "SessionState":{ + "type":"structure", + "members":{ + "dialogAction":{ + "shape":"DialogAction", + "documentation":"The next step that Amazon Lex should take in the conversation with a user.
" + }, + "intent":{ + "shape":"Intent", + "documentation":"The active intent that Amazon Lex is processing.
" + }, + "activeContexts":{ + "shape":"ActiveContextsList", + "documentation":"One or more contexts that indicate to Amazon Lex the context of a request. When a context is active, Amazon Lex considers intents with the matching context as a trigger as the next intent in a session.
" + }, + "sessionAttributes":{ + "shape":"StringMap", + "documentation":"Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
" + }, + "originatingRequestId":{ + "shape":"NonEmptyString", + "documentation":"" + } + }, + "documentation":"The state of the user's session with Amazon Lex.
" + }, + "Slot":{ + "type":"structure", + "members":{ + "value":{ + "shape":"Value", + "documentation":"The current value of the slot.
" + } + }, + "documentation":"A value that Amazon Lex uses to fulfill an intent.
" + }, + "Slots":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"Slot"} + }, + "StartConversationRequest":{ + "type":"structure", + "required":[ + "botId", + "botAliasId", + "localeId", + "requestEventStream", + "sessionId" + ], + "members":{ + "botId":{ + "shape":"BotIdentifier", + "documentation":"The identifier of the bot to process the request.
", + "location":"uri", + "locationName":"botId" + }, + "botAliasId":{ + "shape":"BotAliasIdentifier", + "documentation":"The alias identifier in use for the bot that processes the request.
", + "location":"uri", + "locationName":"botAliasId" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale where the session is in use.
", + "location":"uri", + "locationName":"localeId" + }, + "sessionId":{ + "shape":"SessionId", + "documentation":"The identifier of the user session that is having the conversation.
", + "location":"uri", + "locationName":"sessionId" + }, + "conversationMode":{ + "shape":"ConversationMode", + "documentation":"The conversation type that you are using the Amazon Lex. If the conversation mode is AUDIO you can send both audio and DTMF information. If the mode is TEXT you can only send text.
Represents the stream of events to Amazon Lex from your application. The events are encoded as HTTP/2 data frames.
" + } + }, + "payload":"requestEventStream" + }, + "StartConversationRequestEventStream":{ + "type":"structure", + "members":{ + "ConfigurationEvent":{ + "shape":"ConfigurationEvent", + "documentation":"Configuration information sent from your client application to Amazon Lex
" + }, + "AudioInputEvent":{ + "shape":"AudioInputEvent", + "documentation":"Speech audio sent from your client application to Amazon Lex. Audio starts accumulating when Amazon Lex identifies a voice and continues until a natural pause in the speech is found before processing.
" + }, + "DTMFInputEvent":{ + "shape":"DTMFInputEvent", + "documentation":"DTMF information sent to Amazon Lex by your application. Amazon Lex accumulates the DMTF information from when the user sends the first character and ends
when there's a pause longer that the value configured for the end timeout.
when there's a digit that is the configured end character.
when Amazon Lex accumulates characters equal to the maximum DTMF character configuration.
Text sent from your client application to Amazon Lex. Each TextInputEvent is processed individually.
Event sent from the client application to Amazon Lex to indicate that it has finished playing audio and that Amazon Lex should start listening for user input.
" + }, + "DisconnectionEvent":{ + "shape":"DisconnectionEvent", + "documentation":"Event sent from the client application to indicate to Amazon Lex that the conversation is over.
" + } + }, + "documentation":"Represents a stream of events between your application and Amazon Lex.
", + "eventstream":true + }, + "StartConversationResponse":{ + "type":"structure", + "members":{ + "responseEventStream":{ + "shape":"StartConversationResponseEventStream", + "documentation":"Represents the stream of events from Amazon Lex to your application. The events are encoded as HTTP/2 data frames.
" + } + }, + "payload":"responseEventStream" + }, + "StartConversationResponseEventStream":{ + "type":"structure", + "members":{ + "PlaybackInterruptionEvent":{"shape":"PlaybackInterruptionEvent"}, + "TranscriptEvent":{"shape":"TranscriptEvent"}, + "IntentResultEvent":{ + "shape":"IntentResultEvent", + "documentation":"Event sent from Amazon Lex to the client application containing the current state of the conversation between the user and Amazon Lex.
" + }, + "TextResponseEvent":{"shape":"TextResponseEvent"}, + "AudioResponseEvent":{"shape":"AudioResponseEvent"}, + "HeartbeatEvent":{"shape":"HeartbeatEvent"}, + "AccessDeniedException":{ + "shape":"AccessDeniedException", + "documentation":"Exception thrown when the credentials passed with the request are invalid or expired. Also thrown when the credentials in the request do not have permission to access the StartConversation operation.
Exception thrown if one of the input parameters points to a resource that does not exist. For example, if the bot ID specified does not exist.
" + }, + "ValidationException":{ + "shape":"ValidationException", + "documentation":"Exception thrown when one or more parameters could not be validated. The message contains the name of the field that isn't valid.
Exception thrown when your application exceeds the maximum number of concurrent requests.
" + }, + "InternalServerException":{ + "shape":"InternalServerException", + "documentation":"An error occurred with Amazon Lex.
" + }, + "ConflictException":{ + "shape":"ConflictException", + "documentation":"Exception thrown when two clients are using the same AWS account, Amazon Lex bot, and session ID.
" + }, + "DependencyFailedException":{"shape":"DependencyFailedException"}, + "BadGatewayException":{"shape":"BadGatewayException"} + }, + "documentation":"Represents a stream of events between Amazon Lex and your application.
", + "eventstream":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "StringMap":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"String"} + }, + "Text":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "TextInputEvent":{ + "type":"structure", + "required":["text"], + "members":{ + "text":{ + "shape":"Text", + "documentation":"The text from the user. Amazon Lex processes this as a complete statement.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier that your application assigns to the event. You can use this to identify events in logs.
" + }, + "clientTimestampMillis":{ + "shape":"EpochMillis", + "documentation":"A timestamp set by the client of the date and time that the event was sent to Amazon Lex.
" + } + }, + "documentation":"The event sent from your client application to Amazon Lex with text input from the user.
", + "event":true + }, + "TextResponseEvent":{ + "type":"structure", + "members":{ + "messages":{ + "shape":"Messages", + "documentation":"A list of messages to send to the user. Messages are ordered based on the order that you returned the messages from your Lambda function or the order that the messages are defined in the bot.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
The event sent from Amazon Lex to your application with text to present to the user.
", + "event":true + }, + "ThrottlingException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TranscriptEvent":{ + "type":"structure", + "members":{ + "transcript":{ + "shape":"String", + "documentation":"The transcript of the voice audio from the user.
" + }, + "eventId":{ + "shape":"EventId", + "documentation":"A unique identifier of the event sent by Amazon Lex. The identifier is in the form RESPONSE-N, where N is a number starting with one and incremented for each event sent by Amazon Lex in the current session.
Event sent from Amazon Lex to your client application that contains a transcript of voice audio.
", + "event":true + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Value":{ + "type":"structure", + "required":["interpretedValue"], + "members":{ + "originalValue":{ + "shape":"NonEmptyString", + "documentation":"The text of the utterance from the user that was entered for the slot.
" + }, + "interpretedValue":{ + "shape":"NonEmptyString", + "documentation":"The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the resolvedValues list.
A list of additional values that have been recognized for the slot.
" + } + }, + "documentation":"The value of a slot.
" + } + }, + "documentation":"" +} From d16a1d3fa88bf9b0b2e4e3db2c2c6c5de8a8f9c1 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:12:47 +0000 Subject: [PATCH 6/9] Amazon Lex Model Building V2 Update: This release adds support for Amazon Lex V2 APIs for model building. --- ...ture-AmazonLexModelBuildingV2-33a4057.json | 6 + services/lexmodelsv2/pom.xml | 60 + .../codegen-resources/paginators-1.json | 49 + .../codegen-resources/service-2.json | 5297 +++++++++++++++++ 4 files changed, 5412 insertions(+) create mode 100644 .changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json create mode 100644 services/lexmodelsv2/pom.xml create mode 100644 services/lexmodelsv2/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/lexmodelsv2/src/main/resources/codegen-resources/service-2.json diff --git a/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json b/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json new file mode 100644 index 000000000000..a4a167384d58 --- /dev/null +++ b/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Lex Model Building V2", + "contributor": "", + "description": "This release adds support for Amazon Lex V2 APIs for model building." +} diff --git a/services/lexmodelsv2/pom.xml b/services/lexmodelsv2/pom.xml new file mode 100644 index 000000000000..0041e21b1e80 --- /dev/null +++ b/services/lexmodelsv2/pom.xml @@ -0,0 +1,60 @@ + + + +Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
" + }, + "CreateBot":{ + "name":"CreateBot", + "http":{ + "method":"PUT", + "requestUri":"/bots/", + "responseCode":202 + }, + "input":{"shape":"CreateBotRequest"}, + "output":{"shape":"CreateBotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an Amazon Lex conversational bot.
" + }, + "CreateBotAlias":{ + "name":"CreateBotAlias", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botaliases/", + "responseCode":202 + }, + "input":{"shape":"CreateBotAliasRequest"}, + "output":{"shape":"CreateBotAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called \"PROD\" that your applications use to call the Amazon Lex bot.
" + }, + "CreateBotLocale":{ + "name":"CreateBotLocale", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/", + "responseCode":202 + }, + "input":{"shape":"CreateBotLocaleRequest"}, + "output":{"shape":"CreateBotLocaleResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
" + }, + "CreateBotVersion":{ + "name":"CreateBotVersion", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/", + "responseCode":202 + }, + "input":{"shape":"CreateBotVersionRequest"}, + "output":{"shape":"CreateBotVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates a new version of the bot based on the DRAFT version. If the DRAFT version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.
" + }, + "CreateIntent":{ + "name":"CreateIntent", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/", + "responseCode":200 + }, + "input":{"shape":"CreateIntentRequest"}, + "output":{"shape":"CreateIntentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, \"I want to order a pizza\" and \"Can I order a pizza.\" You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, \"Shall I order your pizza?\"
A conclusion statement to send to the user after the intent is fulfilled. For example, \"I ordered your pizza.\"
A follow-up prompt that asks the user for additional activity. For example, \"Do you want a drink with your pizza?\"
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
" + }, + "DeleteBot":{ + "name":"DeleteBot", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/", + "responseCode":202 + }, + "input":{"shape":"DeleteBotRequest"}, + "output":{"shape":"DeleteBotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.
When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.
Deletes the specified bot alias.
" + }, + "DeleteBotLocale":{ + "name":"DeleteBotLocale", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/", + "responseCode":202 + }, + "input":{"shape":"DeleteBotLocaleRequest"}, + "output":{"shape":"DeleteBotLocaleResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
" + }, + "DeleteBotVersion":{ + "name":"DeleteBotVersion", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/", + "responseCode":202 + }, + "input":{"shape":"DeleteBotVersionRequest"}, + "output":{"shape":"DeleteBotVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.
" + }, + "DeleteIntent":{ + "name":"DeleteIntent", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/", + "responseCode":204 + }, + "input":{"shape":"DeleteIntentRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
" + }, + "DeleteSlot":{ + "name":"DeleteSlot", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId}/", + "responseCode":204 + }, + "input":{"shape":"DeleteSlotRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes the specified slot from an intent.
" + }, + "DeleteSlotType":{ + "name":"DeleteSlotType", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}/", + "responseCode":204 + }, + "input":{"shape":"DeleteSlotTypeRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.
Provides metadata information about a bot.
" + }, + "DescribeBotAlias":{ + "name":"DescribeBotAlias", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botaliases/{botAliasId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeBotAliasRequest"}, + "output":{"shape":"DescribeBotAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Get information about a specific bot alias.
" + }, + "DescribeBotLocale":{ + "name":"DescribeBotLocale", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeBotLocaleRequest"}, + "output":{"shape":"DescribeBotLocaleResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Describes the settings that a bot has for a specific locale.
" + }, + "DescribeBotVersion":{ + "name":"DescribeBotVersion", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/", + "responseCode":200 + }, + "input":{"shape":"DescribeBotVersionRequest"}, + "output":{"shape":"DescribeBotVersionResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Provides metadata about a version of a bot.
" + }, + "DescribeIntent":{ + "name":"DescribeIntent", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeIntentRequest"}, + "output":{"shape":"DescribeIntentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Returns metadata about an intent.
" + }, + "DescribeSlot":{ + "name":"DescribeSlot", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeSlotRequest"}, + "output":{"shape":"DescribeSlotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets metadata information about a slot.
" + }, + "DescribeSlotType":{ + "name":"DescribeSlotType", + "http":{ + "method":"GET", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeSlotTypeRequest"}, + "output":{"shape":"DescribeSlotTypeResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets metadata information about a slot type.
" + }, + "ListBotAliases":{ + "name":"ListBotAliases", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botaliases/", + "responseCode":200 + }, + "input":{"shape":"ListBotAliasesRequest"}, + "output":{"shape":"ListBotAliasesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of aliases for the specified bot.
" + }, + "ListBotLocales":{ + "name":"ListBotLocales", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/", + "responseCode":200 + }, + "input":{"shape":"ListBotLocalesRequest"}, + "output":{"shape":"ListBotLocalesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of locales for the specified bot.
" + }, + "ListBotVersions":{ + "name":"ListBotVersions", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/", + "responseCode":200 + }, + "input":{"shape":"ListBotVersionsRequest"}, + "output":{"shape":"ListBotVersionsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets information about all of the versions of a bot.
The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.
The ListBotVersions operation always returns at least one version, the DRAFT version.
Gets a list of available bots.
" + }, + "ListBuiltInIntents":{ + "name":"ListBuiltInIntents", + "http":{ + "method":"POST", + "requestUri":"/builtins/locales/{localeId}/intents/", + "responseCode":200 + }, + "input":{"shape":"ListBuiltInIntentsRequest"}, + "output":{"shape":"ListBuiltInIntentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.
Gets a list of built-in slot types that meet the specified criteria.
" + }, + "ListIntents":{ + "name":"ListIntents", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/", + "responseCode":200 + }, + "input":{"shape":"ListIntentsRequest"}, + "output":{"shape":"ListIntentsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Get a list of intents that meet the specified criteria.
" + }, + "ListSlotTypes":{ + "name":"ListSlotTypes", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/", + "responseCode":200 + }, + "input":{"shape":"ListSlotTypesRequest"}, + "output":{"shape":"ListSlotTypesResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of slot types that match the specified criteria.
" + }, + "ListSlots":{ + "name":"ListSlots", + "http":{ + "method":"POST", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/", + "responseCode":200 + }, + "input":{"shape":"ListSlotsRequest"}, + "output":{"shape":"ListSlotsResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Gets a list of slots that match the specified criteria.
" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceARN}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"Removes tags from a bot, bot alias, or bot channel.
" + }, + "UpdateBot":{ + "name":"UpdateBot", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateBotRequest"}, + "output":{"shape":"UpdateBotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration of an existing bot.
" + }, + "UpdateBotAlias":{ + "name":"UpdateBotAlias", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botaliases/{botAliasId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateBotAliasRequest"}, + "output":{"shape":"UpdateBotAliasResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration of an existing bot alias.
" + }, + "UpdateBotLocale":{ + "name":"UpdateBotLocale", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateBotLocaleRequest"}, + "output":{"shape":"UpdateBotLocaleResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the settings that a bot has for a specific locale.
" + }, + "UpdateIntent":{ + "name":"UpdateIntent", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/", + "responseCode":200 + }, + "input":{"shape":"UpdateIntentRequest"}, + "output":{"shape":"UpdateIntentResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the settings for an intent.
" + }, + "UpdateSlot":{ + "name":"UpdateSlot", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots/{slotId}/", + "responseCode":200 + }, + "input":{"shape":"UpdateSlotRequest"}, + "output":{"shape":"UpdateSlotResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the settings for a slot.
" + }, + "UpdateSlotType":{ + "name":"UpdateSlotType", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}/", + "responseCode":202 + }, + "input":{"shape":"UpdateSlotTypeRequest"}, + "output":{"shape":"UpdateSlotTypeResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ], + "documentation":"Updates the configuration of an existing slot type.
" + } + }, + "shapes":{ + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "AttachmentTitle":{ + "type":"string", + "max":250, + "min":1 + }, + "AttachmentUrl":{ + "type":"string", + "max":250, + "min":1 + }, + "AudioLogDestination":{ + "type":"structure", + "required":["s3Bucket"], + "members":{ + "s3Bucket":{ + "shape":"S3BucketLogDestination", + "documentation":"The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.
The location of audio log files collected when conversation logging is enabled for a bot.
" + }, + "AudioLogSetting":{ + "type":"structure", + "required":[ + "enabled", + "destination" + ], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Determines whether audio logging in enabled for the bot.
" + }, + "destination":{"shape":"AudioLogDestination"} + }, + "documentation":"Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.
" + }, + "AudioLogSettingsList":{ + "type":"list", + "member":{"shape":"AudioLogSetting"}, + "max":1, + "min":1 + }, + "Boolean":{"type":"boolean"}, + "BotAliasHistoryEvent":{ + "type":"structure", + "members":{ + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that was used in the event.
" + }, + "startDate":{ + "shape":"Timestamp", + "documentation":"The date and time that the event started.
" + }, + "endDate":{ + "shape":"Timestamp", + "documentation":"The date and time that the event ended.
" + } + }, + "documentation":"Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.
" + }, + "BotAliasHistoryEventsList":{ + "type":"list", + "member":{"shape":"BotAliasHistoryEvent"} + }, + "BotAliasId":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^(\\bTSTALIASID\\b|[0-9a-zA-Z]+)$" + }, + "BotAliasLocaleSettings":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.
Specifies the Lambda function that should be used in the locale.
" + } + }, + "documentation":"Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.
" + }, + "BotAliasLocaleSettingsMap":{ + "type":"map", + "key":{"shape":"LocaleId"}, + "value":{"shape":"BotAliasLocaleSettings"}, + "min":1 + }, + "BotAliasStatus":{ + "type":"string", + "enum":[ + "Creating", + "Available", + "Deleting", + "Failed" + ] + }, + "BotAliasSummary":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.
" + }, + "botAliasName":{ + "shape":"Name", + "documentation":"The name of the bot alias.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot alias.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that the bot alias references.
" + }, + "botAliasStatus":{ + "shape":"BotAliasStatus", + "documentation":"The current state of the bot alias. If the status is Available, the alias is ready for use.
A timestamp of the date and time that the bot alias was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot alias was last updated.
" + } + }, + "documentation":"Summary information about bot aliases returned from the ListBotAliases operation.
" + }, + "BotAliasSummaryList":{ + "type":"list", + "member":{"shape":"BotAliasSummary"} + }, + "BotFilter":{ + "type":"structure", + "required":[ + "name", + "values", + "operator" + ], + "members":{ + "name":{ + "shape":"BotFilterName", + "documentation":"The name of the field to filter the list of bots.
" + }, + "values":{ + "shape":"FilterValues", + "documentation":"The value to use for filtering the list of bots.
" + }, + "operator":{ + "shape":"BotFilterOperator", + "documentation":"The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.
Filters the responses returned by the ListBots operation.
The name of the field to filter the list of bots.
" + }, + "values":{ + "shape":"FilterValues", + "documentation":"The value to use for filtering the list of bots.
" + }, + "operator":{ + "shape":"BotLocaleFilterOperator", + "documentation":"The operator to use for the filter. Specify EQ when the ListBotLocales operation should return only aliases that equal the specified value. Specify CO when the ListBotLocales operation should return aliases that contain the specified value.
Filters responses returned by the ListBotLocales operation.
A description of the event that occurred.
" + }, + "eventDate":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the event occurred.
" + } + }, + "documentation":"Provides information about an event that occurred affecting the bot locale.
" + }, + "BotLocaleHistoryEventDescription":{"type":"string"}, + "BotLocaleHistoryEventsList":{ + "type":"list", + "member":{"shape":"BotLocaleHistoryEvent"} + }, + "BotLocaleSortAttribute":{ + "type":"string", + "enum":["BotLocaleName"] + }, + "BotLocaleSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BotLocaleSortAttribute", + "documentation":"The bot locale attribute to sort by.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"Specifies whether to sort the bot locales in ascending or descending order.
" + } + }, + "documentation":"Specifies attributes for sorting a list of bot locales.
" + }, + "BotLocaleStatus":{ + "type":"string", + "enum":[ + "Creating", + "Building", + "Built", + "ReadyExpressTesting", + "Failed", + "Deleting", + "NotBuilt" + ] + }, + "BotLocaleSummary":{ + "type":"structure", + "members":{ + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale of the bot locale.
" + }, + "localeName":{ + "shape":"LocaleName", + "documentation":"The name of the bot locale.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot locale.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The current status of the bot locale. When the status is Built the locale is ready for use.
A timestamp of the date and time that the bot locale was last updated.
" + }, + "lastBuildSubmittedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot locale was last built.
" + } + }, + "documentation":"Summary information about bot locales returned by the ListBotLocales operation.
" + }, + "BotLocaleSummaryList":{ + "type":"list", + "member":{"shape":"BotLocaleSummary"} + }, + "BotSortAttribute":{ + "type":"string", + "enum":["BotName"] + }, + "BotSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BotSortAttribute", + "documentation":"The attribute to use to sort the list of bots.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can choose ascending or descending.
" + } + }, + "documentation":"Specifies attributes for sorting a list of bots.
" + }, + "BotStatus":{ + "type":"string", + "enum":[ + "Creating", + "Available", + "Inactive", + "Deleting", + "Failed", + "Versioning" + ] + }, + "BotSummary":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.
" + }, + "botName":{ + "shape":"Name", + "documentation":"The name of the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The current status of the bot. When the status is Available the bot is ready for use.
The latest numerical version in use for the bot.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that the bot was last updated.
" + } + }, + "documentation":"Summary information about a bot returned by the ListBots operation.
" + }, + "BotSummaryList":{ + "type":"list", + "member":{"shape":"BotSummary"} + }, + "BotVersion":{ + "type":"string", + "max":5, + "min":1, + "pattern":"^(DRAFT|[0-9]+)$" + }, + "BotVersionLocaleDetails":{ + "type":"structure", + "required":["sourceBotVersion"], + "members":{ + "sourceBotVersion":{ + "shape":"BotVersion", + "documentation":"The version of a bot used for a bot locale.
" + } + }, + "documentation":"The version of a bot used for a bot locale.
" + }, + "BotVersionLocaleSpecification":{ + "type":"map", + "key":{"shape":"LocaleId"}, + "value":{"shape":"BotVersionLocaleDetails"}, + "min":1 + }, + "BotVersionSortAttribute":{ + "type":"string", + "enum":["BotVersion"] + }, + "BotVersionSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BotVersionSortAttribute", + "documentation":"The attribute to use to sort the list of versions.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can specify ascending or descending order.
" + } + }, + "documentation":"Specifies attributes for sorting a list of bot versions.
" + }, + "BotVersionSummary":{ + "type":"structure", + "members":{ + "botName":{ + "shape":"Name", + "documentation":"The name of the bot associated with the version.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be updated..
The description of the version.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The status of the bot. When the status is available, the version of the bot is ready for use.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the version was created.
" + } + }, + "documentation":"Summary information about a bot version returned by the ListBotVersions operation.
" + }, + "BotVersionSummaryList":{ + "type":"list", + "member":{"shape":"BotVersionSummary"} + }, + "BoxedBoolean":{ + "type":"boolean", + "box":true + }, + "BuildBotLocaleRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot to build. The identifier is returned in the response from the operation.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot to build. This can only be the draft version of the bot.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "BuildBotLocaleResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the specified bot.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that was built. This is only the draft version of the bot.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale specified of where the bot can be used.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The bot's build status. When the status is ReadyExpressTesting you can test the bot using the utterances defined for the intents and slot types. When the status is Built, the bot is ready for use and can be tested using any utterance.
A timestamp indicating the date and time that the bot was last built for this locale.
" + } + } + }, + "BuiltInIntentSortAttribute":{ + "type":"string", + "enum":["IntentSignature"] + }, + "BuiltInIntentSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BuiltInIntentSortAttribute", + "documentation":"The attribute to use to sort the list of built-in intents.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can specify ascending or descending order.
" + } + }, + "documentation":"Specifies attributes for sorting a list of built-in intents.
" + }, + "BuiltInIntentSummary":{ + "type":"structure", + "members":{ + "intentSignature":{ + "shape":"IntentSignature", + "documentation":"The signature of the built-in intent. Use this to specify the parent intent of a derived intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the intent.
" + } + }, + "documentation":"Provides summary information about a built-in intent for the ListBuiltInIntents operation.
" + }, + "BuiltInIntentSummaryList":{ + "type":"list", + "member":{"shape":"BuiltInIntentSummary"} + }, + "BuiltInOrCustomSlotTypeId":{ + "type":"string", + "max":25, + "min":1, + "pattern":"^((AMAZON\\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$" + }, + "BuiltInSlotTypeSortAttribute":{ + "type":"string", + "enum":["SlotTypeSignature"] + }, + "BuiltInSlotTypeSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"BuiltInSlotTypeSortAttribute", + "documentation":"The attribute to use to sort the list of built-in intents.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can choose ascending or descending.
" + } + }, + "documentation":"Specifies attributes for sorting a list of built-in slot types.
" + }, + "BuiltInSlotTypeSummary":{ + "type":"structure", + "members":{ + "slotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the built-in slot type.
" + } + }, + "documentation":"Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.
" + }, + "BuiltInSlotTypeSummaryList":{ + "type":"list", + "member":{"shape":"BuiltInSlotTypeSummary"} + }, + "BuiltInsMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":20 + }, + "Button":{ + "type":"structure", + "required":[ + "text", + "value" + ], + "members":{ + "text":{ + "shape":"ButtonText", + "documentation":"The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
" + }, + "value":{ + "shape":"ButtonValue", + "documentation":"The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
" + } + }, + "documentation":"Describes a button to use on a response card used to gather slot values from a user.
" + }, + "ButtonText":{ + "type":"string", + "max":50, + "min":1 + }, + "ButtonValue":{ + "type":"string", + "max":50, + "min":1 + }, + "ButtonsList":{ + "type":"list", + "member":{"shape":"Button"}, + "max":5, + "min":0 + }, + "ChildDirected":{"type":"boolean"}, + "CloudWatchLogGroupArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:[\\w\\-]+:logs:[\\w\\-]+:[\\d]{12}:log-group:[\\.\\-_/#A-Za-z0-9]{1,512}(?::\\*)?$" + }, + "CloudWatchLogGroupLogDestination":{ + "type":"structure", + "required":[ + "cloudWatchLogGroupArn", + "logPrefix" + ], + "members":{ + "cloudWatchLogGroupArn":{ + "shape":"CloudWatchLogGroupArn", + "documentation":"The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.
" + }, + "logPrefix":{ + "shape":"LogPrefix", + "documentation":"The prefix of the log stream name within the log group that you specified
" + } + }, + "documentation":"The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.
" + }, + "CodeHookInterfaceVersion":{ + "type":"string", + "max":5, + "min":1 + }, + "CodeHookSpecification":{ + "type":"structure", + "required":["lambdaCodeHook"], + "members":{ + "lambdaCodeHook":{"shape":"LambdaCodeHook"} + }, + "documentation":"Contains information about code hooks that Amazon Lex calls during a conversation.
" + }, + "ConfidenceThreshold":{ + "type":"double", + "max":1, + "min":0 + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ContextTimeToLiveInSeconds":{ + "type":"integer", + "max":86400, + "min":5 + }, + "ContextTurnsToLive":{ + "type":"integer", + "max":20, + "min":1 + }, + "ConversationLogSettings":{ + "type":"structure", + "members":{ + "textLogSettings":{ + "shape":"TextLogSettingsList", + "documentation":"The Amazon CloudWatch Logs settings for logging text and metadata.
" + }, + "audioLogSettings":{ + "shape":"AudioLogSettingsList", + "documentation":"The Amazon S3 settings for logging audio to an S3 bucket.
" + } + }, + "documentation":"Configures conversation logging that saves audio, text, and metadata for the conversations with your users.
" + }, + "CreateBotAliasRequest":{ + "type":"structure", + "required":[ + "botAliasName", + "botId" + ], + "members":{ + "botAliasName":{ + "shape":"Name", + "documentation":"The alias to create. The name must be unique for the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the alias. Use this description to help identify the alias.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot that this alias points to. You can use the operation to change the bot version associated with the alias.
" + }, + "botAliasLocaleSettings":{ + "shape":"BotAliasLocaleSettingsMap", + "documentation":"Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.
" + }, + "conversationLogSettings":{ + "shape":"ConversationLogSettings", + "documentation":"Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.
" + }, + "sentimentAnalysisSettings":{"shape":"SentimentAnalysisSettings"}, + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that the alias applies to.
", + "location":"uri", + "locationName":"botId" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the UpdateBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.
The unique identifier of the bot alias.
" + }, + "botAliasName":{ + "shape":"Name", + "documentation":"The name specified for the bot alias.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the bot alias.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot associated with this alias.
" + }, + "botAliasLocaleSettings":{ + "shape":"BotAliasLocaleSettingsMap", + "documentation":"Configuration information for a specific locale.
" + }, + "conversationLogSettings":{ + "shape":"ConversationLogSettings", + "documentation":"The conversation log settings specified for the alias.
" + }, + "sentimentAnalysisSettings":{"shape":"SentimentAnalysisSettings"}, + "botAliasStatus":{ + "shape":"BotAliasStatus", + "documentation":"The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.
The unique identifier of the bot that this alias applies to.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A Unix timestamp indicating the date and time that the bot alias was created.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of tags associated with the bot alias.
" + } + } + }, + "CreateBotLocaleRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "nluIntentConfidenceThreshold" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot to create the locale for.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot to create the locale for. This can only be the draft version of the bot.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the bot will be used in. The string must match one of the supported locales. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the bot locale. Use this to help identify the bot locale in lists.
" + }, + "nluIntentConfidenceThreshold":{ + "shape":"ConfidenceThreshold", + "documentation":"Determines the threshold where Amazon Lex will insert the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents. AMAZON.FallbackIntent and AMAZON.KendraSearchIntent are only inserted if they are configured for the bot.
For example, suppose a bot is configured with the confidence threshold of 0.80 and the AMAZON.FallbackIntent. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the PostText operation would be:
AMAZON.FallbackIntent
IntentA
IntentB
IntentC
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
" + } + } + }, + "CreateBotLocaleResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The specified bot identifier.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The specified bot version.
" + }, + "localeName":{ + "shape":"LocaleName", + "documentation":"The specified locale name.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The specified locale identifier.
" + }, + "description":{ + "shape":"Description", + "documentation":"The specified description of the bot locale.
" + }, + "nluIntentConfidenceThreshold":{ + "shape":"ConfidenceThreshold", + "documentation":"The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.
The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The status of the bot.
When the status is Creating the bot locale is being configured. When the status is Building Amazon Lex is building the bot for testing and use.
If the status of the bot is ReadyExpressTesting, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is Built.
If there was a problem with building the bot, the status is Failed. If the bot was saved but not built, the status is NotBuilt.
A timestamp specifying the date and time that the bot locale was created.
" + } + } + }, + "CreateBotRequest":{ + "type":"structure", + "required":[ + "botName", + "roleArn", + "dataPrivacy", + "idleSessionTTLInSeconds" + ], + "members":{ + "botName":{ + "shape":"Name", + "documentation":"The name of the bot. The bot name must be unique in the account that creates the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the bot. It appears in lists to help you identify a particular bot.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"Provides information on additional privacy protections Amazon Lex should use with the bot's data.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
" + }, + "botTags":{ + "shape":"TagMap", + "documentation":"A list of tags to add to the bot. You can only add tags when you create a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.
A list of tags to add to the test alias for a bot. You can only add tags when you create a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.
A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.
" + }, + "botName":{ + "shape":"Name", + "documentation":"The name specified for the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the bot.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The IAM role specified for the bot.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"The data privacy settings specified for the bot.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The session idle time specified for the bot.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the Draft version of the bot.
A timestamp indicating the date and time that the bot was created.
" + }, + "botTags":{ + "shape":"TagMap", + "documentation":"A list of tags associated with the bot.
" + }, + "testBotAliasTags":{ + "shape":"TagMap", + "documentation":"A list of tags associated with the test alias for the bot.
" + } + } + }, + "CreateBotVersionRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersionLocaleSpecification" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot to create the version for.
", + "location":"uri", + "locationName":"botId" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the version. Use the description to help identify the version in lists.
" + }, + "botVersionLocaleSpecification":{ + "shape":"BotVersionLocaleSpecification", + "documentation":"Specifies the locales that Amazon Lex adds to this version. You can choose the Draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.
The bot identifier specified in the request.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the version specified in the request.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version number assigned to the version.
" + }, + "botVersionLocaleSpecification":{ + "shape":"BotVersionLocaleSpecification", + "documentation":"The source versions used for each locale in the new version.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"When you send a request to create or update a bot, Amazon Lex sets the status response element to Creating. After Amazon Lex builds the bot, it sets status to Available. If Amazon Lex can't build the bot, it sets status to Failed.
A timestamp of the date and time that the version was created.
" + } + } + }, + "CreateIntentRequest":{ + "type":"structure", + "required":[ + "intentName", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "intentName":{ + "shape":"Name", + "documentation":"The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the intent. Use the description to help identify the intent in lists.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"A unique identifier for the built-in intent to base this intent on.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"An array of strings that a user might say to signal the intent. For example, \"I want a pizza\", or \"I want a {PizzaSize} pizza\".
In an utterance, slot names are enclosed in curly braces (\"{\", \"}\") to indicate where they should be displayed in the utterance shown to the user..
" + }, + "dialogCodeHook":{ + "shape":"DialogCodeHookSettings", + "documentation":"Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true. You might find John's phone number and set the corresponding session attribute.
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
" + }, + "intentConfirmationSetting":{ + "shape":"IntentConfirmationSetting", + "documentation":"Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers \"no,\" the settings contain a statement that is sent to the user to end the intent.
" + }, + "intentClosingSetting":{ + "shape":"IntentClosingSetting", + "documentation":"Sets the response that Amazon Lex sends to the user when the intent is closed.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts property or it can be set at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.
Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.
The identifier of the bot associated with this intent.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The identifier of the version of the bot associated with this intent.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "CreateIntentResponse":{ + "type":"structure", + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"A unique identifier for the intent.
" + }, + "intentName":{ + "shape":"Name", + "documentation":"The name specified for the intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the intent.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"The signature of the parent intent specified for the intent.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"The sample utterances specified for the intent.
" + }, + "dialogCodeHook":{ + "shape":"DialogCodeHookSettings", + "documentation":"The dialog Lambda function specified for the intent.
" + }, + "fulfillmentCodeHook":{ + "shape":"FulfillmentCodeHookSettings", + "documentation":"The fulfillment Lambda function specified for the intent.
" + }, + "intentConfirmationSetting":{ + "shape":"IntentConfirmationSetting", + "documentation":"The confirmation setting specified for the intent.
" + }, + "intentClosingSetting":{ + "shape":"IntentClosingSetting", + "documentation":"The closing setting specified for the intent.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"The list of input contexts specified for the intent.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"The list of output contexts specified for the intent.
" + }, + "kendraConfiguration":{ + "shape":"KendraConfiguration", + "documentation":"Configuration for searching a Amazon Kendra index specified for the intent.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the intent.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The identifier of the version of the bot associated with the intent.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The locale that the intent is specified to use.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the intent was created.
" + } + } + }, + "CreateSlotRequest":{ + "type":"structure", + "required":[ + "slotName", + "slotTypeId", + "valueElicitationSetting", + "botId", + "botVersion", + "localeId", + "intentId" + ], + "members":{ + "slotName":{ + "shape":"Name", + "documentation":"The name of the slot. Slot names must be unique within the bot that contains the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the slot. Use this to help identify the slot in lists.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
" + }, + "valueElicitationSetting":{ + "shape":"SlotValueElicitationSetting", + "documentation":"Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
" + }, + "obfuscationSetting":{ + "shape":"ObfuscationSetting", + "documentation":"Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation, slot values are obfuscated in the log output. If the value is None, the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the slot.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent that contains the slot.
", + "location":"uri", + "locationName":"intentId" + } + } + }, + "CreateSlotResponse":{ + "type":"structure", + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
" + }, + "slotName":{ + "shape":"Name", + "documentation":"The name specified for the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description associated with the slot.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The unique identifier of the slot type associated with this slot.
" + }, + "valueElicitationSetting":{ + "shape":"SlotValueElicitationSetting", + "documentation":"The value elicitation settings specified for the slot.
" + }, + "obfuscationSetting":{ + "shape":"ObfuscationSetting", + "documentation":"Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot associated with the slot.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the slot.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and local specified for the slot.
" + }, + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier of the intent associated with the slot.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the date and time that the slot was created.
" + } + } + }, + "CreateSlotTypeRequest":{ + "type":"structure", + "required":[ + "slotTypeName", + "valueSelectionSetting", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "slotTypeName":{ + "shape":"Name", + "documentation":"The name for the slot. A slot type name must be unique within the account.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the slot type. Use the description to help identify the slot type in lists.
" + }, + "slotTypeValues":{ + "shape":"SlotTypeValues", + "documentation":"A list of SlotTypeValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.
Determines the strategy that Amazon Lex uses to select a value from the list of possible values. The field can be set to one of the following values:
OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
TopResolution - If there is a resolution list for the slot, return the first value in the resolution list. If there is no resolution list, return null.
If you don't specify the valueSelectionSetting parameter, the default is OriginalValue.
The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type.
Only AMAZON.AlphaNumeric is supported.
The identifier of the bot associated with this slot type.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The identifier of the bot version associated with this slot type.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "CreateSlotTypeResponse":{ + "type":"structure", + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.
The name specified for the slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the slot type.
" + }, + "slotTypeValues":{ + "shape":"SlotTypeValues", + "documentation":"The list of values that the slot type can assume.
" + }, + "valueSelectionSetting":{ + "shape":"SlotValueSelectionSetting", + "documentation":"The strategy that Amazon Lex uses to select a value from the list of possible values.
" + }, + "parentSlotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"The signature of the base slot type specified for the slot type.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier for the bot associated with the slot type.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the slot type.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The specified language and local specified for the slot type.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot type was created.
" + } + } + }, + "CustomPayload":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"CustomPayloadValue", + "documentation":"The string that is sent to your application.
" + } + }, + "documentation":"A custom response string that Amazon Lex sends to your application. You define the content and structure the string.
" + }, + "CustomPayloadValue":{ + "type":"string", + "max":1000, + "min":1 + }, + "DataPrivacy":{ + "type":"structure", + "required":["childDirected"], + "members":{ + "childDirected":{ + "shape":"ChildDirected", + "documentation":"For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
By default, data stored by Amazon Lex is encrypted. The DataPrivacy structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot.
The unique identifier of the bot alias to delete.
", + "location":"uri", + "locationName":"botAliasId" + }, + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot associated with the alias to delete.
", + "location":"uri", + "locationName":"botId" + }, + "skipResourceInUseCheck":{ + "shape":"SkipResourceInUseCheck", + "documentation":"When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.
", + "location":"querystring", + "locationName":"skipResourceInUseCheck" + } + } + }, + "DeleteBotAliasResponse":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The unique identifier of the bot alias to delete.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that contains the alias to delete.
" + }, + "botAliasStatus":{ + "shape":"BotAliasStatus", + "documentation":"The current status of the alias. The status is Deleting while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the ListBotAliases operation.
The unique identifier of the bot that contains the locale.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the locale.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DeleteBotLocaleResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contained the deleted locale.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contained the deleted locale.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale of the deleted locale.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The status of deleting the bot locale. The locale first enters the Deleting status. Once the locale is deleted it no longer appears in the list of locales for the bot.
The identifier of the bot to delete.
", + "location":"uri", + "locationName":"botId" + }, + "skipResourceInUseCheck":{ + "shape":"SkipResourceInUseCheck", + "documentation":"When true, Amazon Lex doesn't check to see if another resource, such as an alias, is using the bot before it is deleted.
The unique identifier of the bot that Amazon Lex is deleting.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The current status of the bot. The status is Deleting while the bot and its associated resources are being deleted.
The identifier of the bot that contains the version.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot to delete.
", + "location":"uri", + "locationName":"botVersion" + }, + "skipResourceInUseCheck":{ + "shape":"SkipResourceInUseCheck", + "documentation":"By default, the DeleteBotVersion operations throws a ResourceInUseException exception if you try to delete a bot version that has an alias pointing at it. Set the skipResourceInUseCheck parameter to true to skip this check and remove the version even if an alias points to it.
The identifier of the bot that is being deleted.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot that is being deleted.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The current status of the bot.
" + } + } + }, + "DeleteIntentRequest":{ + "type":"structure", + "required":[ + "intentId", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier of the intent to delete.
", + "location":"uri", + "locationName":"intentId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the intent.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the intent.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DeleteSlotRequest":{ + "type":"structure", + "required":[ + "slotId", + "botId", + "botVersion", + "localeId", + "intentId" + ], + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The identifier of the slot to delete.
", + "location":"uri", + "locationName":"slotId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot to delete.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the slot to delete.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the slot will be deleted from. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent associated with the slot.
", + "location":"uri", + "locationName":"intentId" + } + } + }, + "DeleteSlotTypeRequest":{ + "type":"structure", + "required":[ + "slotTypeId", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The identifier of the slot type to delete.
", + "location":"uri", + "locationName":"slotTypeId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot type.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the slot type.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale that the slot type will be deleted from. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "skipResourceInUseCheck":{ + "shape":"SkipResourceInUseCheck", + "documentation":"By default, the DeleteSlotType operations throws a ResourceInUseException exception if you try to delete a slot type used by a slot. Set the skipResourceInUseCheck parameter to true to skip this check and remove the slot type even if a slot uses it.
The identifier of the bot alias to describe.
", + "location":"uri", + "locationName":"botAliasId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the bot alias to describe.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "DescribeBotAliasResponse":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The identifier of the bot alias.
" + }, + "botAliasName":{ + "shape":"Name", + "documentation":"The name of the bot alias.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot alias.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the bot alias.
" + }, + "botAliasLocaleSettings":{ + "shape":"BotAliasLocaleSettingsMap", + "documentation":"The locale settings that are unique to the alias.
" + }, + "conversationLogSettings":{ + "shape":"ConversationLogSettings", + "documentation":"Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.
" + }, + "sentimentAnalysisSettings":{"shape":"SentimentAnalysisSettings"}, + "botAliasHistoryEvents":{ + "shape":"BotAliasHistoryEventsList", + "documentation":"A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.
" + }, + "botAliasStatus":{ + "shape":"BotAliasStatus", + "documentation":"The current status of the alias. When the alias is Available, the alias is ready for use with your bot.
The identifier of the bot associated with the bot alias.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the alias was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the alias was last updated.
" + } + } + }, + "DescribeBotLocaleRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the locale.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The identifier of the version of the bot associated with the locale.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DescribeBotLocaleResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the locale.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The identifier of the version of the bot associated with the locale.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The unique identifier of the described locale.
" + }, + "localeName":{ + "shape":"LocaleName", + "documentation":"The name of the locale.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the locale.
" + }, + "nluIntentConfidenceThreshold":{ + "shape":"ConfidenceThreshold", + "documentation":"The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
" + }, + "intentsCount":{ + "shape":"ResourceCount", + "documentation":"The number of intents defined for the locale.
" + }, + "slotTypesCount":{ + "shape":"ResourceCount", + "documentation":"The number of slot types defined for the locale.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.
if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.
The date and time that the locale was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that the locale was last updated.
" + }, + "lastBuildSubmittedDateTime":{ + "shape":"Timestamp", + "documentation":"The date and time that the locale was last submitted for building.
" + }, + "botLocaleHistoryEvents":{ + "shape":"BotLocaleHistoryEventsList", + "documentation":"History of changes, such as when a locale is used in an alias, that have taken place for the locale.
" + } + } + }, + "DescribeBotRequest":{ + "type":"structure", + "required":["botId"], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot to describe.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "DescribeBotResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot.
" + }, + "botName":{ + "shape":"Name", + "documentation":"The name of the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"Settings for managing data privacy of the bot and its conversations with users.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.
A timestamp of the date and time that the bot was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot was last updated.
" + } + } + }, + "DescribeBotVersionRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot containing the version to return metadata for.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot to return metadata for.
", + "location":"uri", + "locationName":"botVersion" + } + } + }, + "DescribeBotVersionResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the version.
" + }, + "botName":{ + "shape":"Name", + "documentation":"The name of the bot that contains the version.
" + }, + "botVersion":{ + "shape":"NumericalBotVersion", + "documentation":"The version of the bot to describe.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the bot.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"Data privacy settings for the bot version.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"The current status of the bot. When the status is Available, the bot version is ready for use.
If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.
A timestamp of the date and time that the bot version was created.
" + } + } + }, + "DescribeIntentRequest":{ + "type":"structure", + "required":[ + "intentId", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent to describe.
", + "location":"uri", + "locationName":"intentId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the intent.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the intent.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DescribeIntentResponse":{ + "type":"structure", + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier assigned to the intent when it was created.
" + }, + "intentName":{ + "shape":"Name", + "documentation":"The name specified for the intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the intent.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"The identifier of the built-in intent that this intent is derived from, if any.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"User utterances that trigger this intent.
" + }, + "dialogCodeHook":{ + "shape":"DialogCodeHookSettings", + "documentation":"The Lambda function called during each turn of a conversation with the intent.
" + }, + "fulfillmentCodeHook":{ + "shape":"FulfillmentCodeHookSettings", + "documentation":"The Lambda function called when the intent is complete and ready for fulfillment.
" + }, + "slotPriorities":{ + "shape":"SlotPrioritiesList", + "documentation":"The list that determines the priority that slots should be elicited from the user.
" + }, + "intentConfirmationSetting":{ + "shape":"IntentConfirmationSetting", + "documentation":"Prompts that Amazon Lex sends to the user to confirm completion of an intent.
" + }, + "intentClosingSetting":{ + "shape":"IntentClosingSetting", + "documentation":"The response that Amazon Lex sends to when the intent is closed.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"A list of contexts that must be active for the intent to be considered for sending to the user.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"A list of contexts that are activated when the intent is fulfilled.
" + }, + "kendraConfiguration":{ + "shape":"KendraConfiguration", + "documentation":"Configuration information required to use the AMAZON.KendraSearchIntent intent.
The identifier of the bot associated with the intent.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot associated with the intent.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale specified for the intent.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the intent was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the intent was last updated.
" + } + } + }, + "DescribeSlotRequest":{ + "type":"structure", + "required":[ + "slotId", + "botId", + "botVersion", + "localeId", + "intentId" + ], + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier for the slot.
", + "location":"uri", + "locationName":"slotId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the slot.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent that contains the slot.
", + "location":"uri", + "locationName":"intentId" + } + } + }, + "DescribeSlotResponse":{ + "type":"structure", + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier generated for the slot.
" + }, + "slotName":{ + "shape":"Name", + "documentation":"The name specified for the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the slot.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The identifier of the slot type that determines the values entered into the slot.
" + }, + "valueElicitationSetting":{ + "shape":"SlotValueElicitationSetting", + "documentation":"Prompts that Amazon Lex uses to elicit a value for the slot.
" + }, + "obfuscationSetting":{ + "shape":"ObfuscationSetting", + "documentation":"Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.
The identifier of the bot associated with the slot.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the slot.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale specified for the slot.
" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent associated with the slot.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot was last updated.
" + } + } + }, + "DescribeSlotTypeRequest":{ + "type":"structure", + "required":[ + "slotTypeId", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The identifier of the slot type.
", + "location":"uri", + "locationName":"slotTypeId" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot type.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the slot type.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "DescribeSlotTypeResponse":{ + "type":"structure", + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The unique identifier for the slot type.
" + }, + "slotTypeName":{ + "shape":"Name", + "documentation":"The name specified for the slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description specified for the slot type.
" + }, + "slotTypeValues":{ + "shape":"SlotTypeValues", + "documentation":"The values that the slot type can take. Includes any synonyms for the slot type values.
" + }, + "valueSelectionSetting":{ + "shape":"SlotValueSelectionSetting", + "documentation":"The strategy that Amazon Lex uses to choose a value from a list of possible values.
" + }, + "parentSlotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"The built in slot type used as a parent to this slot type.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot associated with the slot type.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot associated with the slot type.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale specified for the slot type.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot type was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot type was last updated.
" + } + } + }, + "Description":{ + "type":"string", + "max":200, + "min":0 + }, + "DialogCodeHookSettings":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Enables the dialog code hook so that it processes user requests.
" + } + }, + "documentation":"Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
" + }, + "DraftBotVersion":{ + "type":"string", + "max":5, + "min":5, + "pattern":"^DRAFT$" + }, + "ExceptionMessage":{"type":"string"}, + "FailureReason":{"type":"string"}, + "FailureReasons":{ + "type":"list", + "member":{"shape":"FailureReason"} + }, + "FilterValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[0-9a-zA-Z_()\\s-]+$" + }, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"}, + "max":1, + "min":1 + }, + "FulfillmentCodeHookSettings":{ + "type":"structure", + "required":["enabled"], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Indicates whether a Lambda function should be invoked to fulfill a specific intent.
" + } + }, + "documentation":"Determines if a Lambda function should be invoked for a specific intent.
" + }, + "Id":{ + "type":"string", + "max":10, + "min":10, + "pattern":"^[0-9a-zA-Z]+$" + }, + "ImageResponseCard":{ + "type":"structure", + "required":["title"], + "members":{ + "title":{ + "shape":"AttachmentTitle", + "documentation":"The title to display on the response card. The format of the title is determined by the platform displaying the response card.
" + }, + "subtitle":{ + "shape":"AttachmentTitle", + "documentation":"The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
" + }, + "imageUrl":{ + "shape":"AttachmentUrl", + "documentation":"The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
" + }, + "buttons":{ + "shape":"ButtonsList", + "documentation":"A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
" + } + }, + "documentation":"A card that is shown to the user by a messaging platform. You define the contents of the card, the card is displayed by the platform.
When you use a response card, the response from the user is constrained to the text associated with a button on the card.
" + }, + "InputContext":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"The name of the context.
" + } + }, + "documentation":"The name of a context that must be active for an intent to be selected by Amazon Lex.
" + }, + "InputContextsList":{ + "type":"list", + "member":{"shape":"InputContext"}, + "max":5, + "min":0 + }, + "IntentClosingSetting":{ + "type":"structure", + "required":["closingResponse"], + "members":{ + "closingResponse":{ + "shape":"ResponseSpecification", + "documentation":"The response that Amazon Lex sends to the user when the intent is complete.
" + } + }, + "documentation":"Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
" + }, + "IntentConfirmationSetting":{ + "type":"structure", + "required":[ + "promptSpecification", + "declinationResponse" + ], + "members":{ + "promptSpecification":{ + "shape":"PromptSpecification", + "documentation":"Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
When the user answers \"no\" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.
Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
" + }, + "IntentFilter":{ + "type":"structure", + "required":[ + "name", + "values", + "operator" + ], + "members":{ + "name":{ + "shape":"IntentFilterName", + "documentation":"The name of the field to use for the filter.
" + }, + "values":{ + "shape":"FilterValues", + "documentation":"The value to use for the filter.
" + }, + "operator":{ + "shape":"IntentFilterOperator", + "documentation":"The operator to use for the filter. Specify EQ when the ListIntents operation should return only aliases that equal the specified value. Specify CO when the ListIntents operation should return aliases that contain the specified value.
Filters the response from the ListIntents operation.
The attribute to use to sort the list of intents.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can choose ascending or descending.
" + } + }, + "documentation":"Specifies attributes for sorting a list of intents.
" + }, + "IntentSummary":{ + "type":"structure", + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier assigned to the intent. Use this ID to get detailed information about the intent with the DescribeIntent operation.
The name of the intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the intent.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"If this intent is derived from a built-in intent, the name of the parent intent.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"The input contexts that must be active for this intent to be considered for recognition.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"The output contexts that are activated when this intent is fulfilled.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the date and time that the intent was last updated.
" + } + }, + "documentation":"Summary information about an intent returned by the ListIntents operation.
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
" + }, + "queryFilterStringEnabled":{ + "shape":"Boolean", + "documentation":"Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
" + }, + "queryFilterString":{ + "shape":"QueryFilterString", + "documentation":"A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries.
" + } + }, + "documentation":"Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
" + }, + "KendraIndexArn":{ + "type":"string", + "max":2048, + "min":32, + "pattern":"^arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\\/[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$" + }, + "LambdaARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?" + }, + "LambdaCodeHook":{ + "type":"structure", + "required":[ + "lambdaARN", + "codeHookInterfaceVersion" + ], + "members":{ + "lambdaARN":{ + "shape":"LambdaARN", + "documentation":"The Amazon Resource Name (ARN) of the Lambda function.
" + }, + "codeHookInterfaceVersion":{ + "shape":"CodeHookInterfaceVersion", + "documentation":"The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.
" + } + }, + "documentation":"Specifies a Lambda function that verifies requests to a bot or fulfilles the user's request to a bot.
" + }, + "ListBotAliasesRequest":{ + "type":"structure", + "required":["botId"], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot to list aliases for.
", + "location":"uri", + "locationName":"botId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListBotAliases operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more aliases available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListBotAliases operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.
The identifier of the bot associated with the aliases.
" + } + } + }, + "ListBotLocalesRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot to list locales for.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot to list locales for.
", + "location":"uri", + "locationName":"botVersion" + }, + "sortBy":{ + "shape":"BotLocaleSortBy", + "documentation":"Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.
" + }, + "filters":{ + "shape":"BotLocaleFilters", + "documentation":"Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of aliases to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListBotLocales operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token as the nextToken parameter to return the next page of results.
The identifier of the bot to list locales for.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.
Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.
The identifier of the bot to list versions for.
", + "location":"uri", + "locationName":"botId" + }, + "sortBy":{ + "shape":"BotVersionSortBy", + "documentation":"Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of versions to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response to the ListBotVersion operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
The identifier of the bot to list versions for.
" + }, + "botVersionSummaries":{ + "shape":"BotVersionSummaryList", + "documentation":"Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more versions available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListBotVersions operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.
Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
" + }, + "filters":{ + "shape":"BotFilters", + "documentation":"Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more bots available, the nextToken field contains a token to the next page of results.
A token that indicates whether there are more results to return in a response to the ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.
The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "sortBy":{ + "shape":"BuiltInIntentSortBy", + "documentation":"Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.
" + }, + "maxResults":{ + "shape":"BuiltInsMaxResults", + "documentation":"The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListBuiltInIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListBuiltInIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotAliases operation request to get the next page of results.
The language and locale of the intents in the list.
" + } + } + }, + "ListBuiltInSlotTypesRequest":{ + "type":"structure", + "required":["localeId"], + "members":{ + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "sortBy":{ + "shape":"BuiltInSlotTypeSortBy", + "documentation":"Determines the sort order for the response from the ListBuiltInSlotTypes operation. You can choose to sort by the slot type signature in either ascending or descending order.
The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListBuiltInSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListBuiltInSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a LIstBuiltInSlotTypes operation request to get the next page of results.
The language and locale of the slot types in the list.
" + } + } + }, + "ListIntentsRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that contains the intent.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the intent.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the intents to list. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "sortBy":{ + "shape":"IntentSortBy", + "documentation":"Determines the sort order for the response from the ListIntents operation. You can choose to sort by the intent name or last updated date in either ascending or descending order.
Provides the specification of a filter used to limit the intents in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
The identifier of the bot that contains the intent.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the intent.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale of the intents in the list.
" + }, + "intentSummaries":{ + "shape":"IntentSummaryList", + "documentation":"Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.
The unique identifier of the bot that contains the slot types.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the slot type.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the slot types to list. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "sortBy":{ + "shape":"SlotTypeSortBy", + "documentation":"Determines the sort order for the response from the ListSlotTypes operation. You can choose to sort by the slot type name or last updated date in either ascending or descending order.
Provides the specification of a filter used to limit the slot types in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListSlotTypes operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
The identifier of the bot that contains the slot types.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the slot types.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and local of the slot types in the list.
" + }, + "slotTypeSummaries":{ + "shape":"SlotTypeSummaryList", + "documentation":"Summary information for the slot types that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slot types available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListSlotTypes operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlotTypes operation request to get the next page of results.
The identifier of the bot that contains the slot.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the slot.
", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier of the intent that contains the slot.
", + "location":"uri", + "locationName":"intentId" + }, + "sortBy":{ + "shape":"SlotSortBy", + "documentation":"Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"If the response from the ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
The identifier of the bot that contains the slots.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The version of the bot that contains the slots.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale of the slots in the list.
" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent that contains the slots.
" + }, + "slotSummaries":{ + "shape":"SlotSummaryList", + "documentation":"Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slots available, the nextToken field contains a token to get the next page of results.
A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.
The Amazon Resource Name (ARN) of the resource to get a list of tags for.
", + "location":"uri", + "locationName":"resourceARN" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"The tags associated with a resource.
" + } + } + }, + "LocaleId":{"type":"string"}, + "LocaleName":{"type":"string"}, + "LogPrefix":{ + "type":"string", + "max":1024 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "Message":{ + "type":"structure", + "members":{ + "plainTextMessage":{ + "shape":"PlainTextMessage", + "documentation":"A message in plain text format.
" + }, + "customPayload":{ + "shape":"CustomPayload", + "documentation":"A message in a custom format defined by the client application.
" + }, + "ssmlMessage":{ + "shape":"SSMLMessage", + "documentation":"A message in Speech Synthesis Markup Language (SSML).
" + }, + "imageResponseCard":{ + "shape":"ImageResponseCard", + "documentation":"A message that defines a response card that the client application can show to the user.
" + } + }, + "documentation":"The object that provides message text and it's type.
" + }, + "MessageGroup":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"Message", + "documentation":"The primary message that Amazon Lex should send to the user.
" + }, + "variations":{ + "shape":"MessageVariationsList", + "documentation":"Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
" + } + }, + "documentation":"Provides one or more messages that Amazon Lex should send to the user.
" + }, + "MessageGroupsList":{ + "type":"list", + "member":{"shape":"MessageGroup"}, + "max":5, + "min":1 + }, + "MessageVariationsList":{ + "type":"list", + "member":{"shape":"Message"}, + "max":2, + "min":0 + }, + "Name":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([0-9a-zA-Z][_-]?)+$" + }, + "NextToken":{"type":"string"}, + "NumericalBotVersion":{ + "type":"string", + "max":5, + "min":1, + "pattern":"^[0-9]+$" + }, + "ObfuscationSetting":{ + "type":"structure", + "required":["obfuscationSettingType"], + "members":{ + "obfuscationSettingType":{ + "shape":"ObfuscationSettingType", + "documentation":"Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
" + } + }, + "documentation":"Determines whether Amazon Lex obscures slot values in conversation logs.
" + }, + "ObfuscationSettingType":{ + "type":"string", + "enum":[ + "None", + "DefaultObfuscation" + ] + }, + "OutputContext":{ + "type":"structure", + "required":[ + "name", + "timeToLiveInSeconds", + "turnsToLive" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"The name of the output context.
" + }, + "timeToLiveInSeconds":{ + "shape":"ContextTimeToLiveInSeconds", + "documentation":"The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
" + }, + "turnsToLive":{ + "shape":"ContextTurnsToLive", + "documentation":"The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
" + } + }, + "documentation":"Describes a session context that is activated when an intent is fulfilled.
" + }, + "OutputContextsList":{ + "type":"list", + "member":{"shape":"OutputContext"}, + "max":10, + "min":0 + }, + "PlainTextMessage":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"PlainTextMessageValue", + "documentation":"The message to send to the user.
" + } + }, + "documentation":"Defines an ASCII text message to send to the user.
" + }, + "PlainTextMessageValue":{ + "type":"string", + "max":1000, + "min":1 + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriorityValue":{ + "type":"integer", + "max":25, + "min":0 + }, + "PromptMaxRetries":{ + "type":"integer", + "max":5, + "min":0 + }, + "PromptSpecification":{ + "type":"structure", + "required":[ + "messageGroups", + "maxRetries" + ], + "members":{ + "messageGroups":{ + "shape":"MessageGroupsList", + "documentation":"A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
" + }, + "maxRetries":{ + "shape":"PromptMaxRetries", + "documentation":"The maximum number of times the bot tries to elicit a resonse from the user using this prompt.
" + }, + "allowInterrupt":{ + "shape":"BoxedBoolean", + "documentation":"Indicates whether the user can interrupt a speech prompt from the bot.
" + } + }, + "documentation":"Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.
" + }, + "QueryFilterString":{ + "type":"string", + "max":5000, + "min":1 + }, + "RegexPattern":{ + "type":"string", + "max":100, + "min":1 + }, + "ResourceCount":{"type":"integer"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResponseSpecification":{ + "type":"structure", + "required":["messageGroups"], + "members":{ + "messageGroups":{ + "shape":"MessageGroupsList", + "documentation":"A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
" + }, + "allowInterrupt":{ + "shape":"BoxedBoolean", + "documentation":"Indicates whether the user can interrupt a speech response from Amazon Lex.
" + } + }, + "documentation":"Specifies a list of message groups that Amazon Lex uses to respond the user input.
" + }, + "RetryAfterSeconds":{"type":"integer"}, + "RoleArn":{ + "type":"string", + "max":2048, + "min":32, + "pattern":"^arn:aws:iam::[0-9]{12}:role/.*$" + }, + "S3BucketArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + }, + "S3BucketLogDestination":{ + "type":"structure", + "required":[ + "s3BucketArn", + "logPrefix" + ], + "members":{ + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.
" + }, + "s3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.
" + }, + "logPrefix":{ + "shape":"LogPrefix", + "documentation":"The S3 prefix to assign to audio log files.
" + } + }, + "documentation":"Specifies an Amazon S3 bucket for logging audio conversations
" + }, + "SSMLMessage":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"SSMLMessageValue", + "documentation":"The SSML text that defines the prompt.
" + } + }, + "documentation":"Defines a Speech Synthesis Markup Language (SSML) prompt.
" + }, + "SSMLMessageValue":{ + "type":"string", + "max":1000, + "min":1 + }, + "SampleUtterance":{ + "type":"structure", + "required":["utterance"], + "members":{ + "utterance":{ + "shape":"Utterance", + "documentation":"The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
" + } + }, + "documentation":"A sample utterance that invokes an intent or respond to a slot elicitation prompt.
" + }, + "SampleUtterancesList":{ + "type":"list", + "member":{"shape":"SampleUtterance"} + }, + "SampleValue":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"Value", + "documentation":"The value that can be used for a slot type.
" + } + }, + "documentation":"Defines one of the values for a slot type.
" + }, + "SentimentAnalysisSettings":{ + "type":"structure", + "required":["detectSentiment"], + "members":{ + "detectSentiment":{ + "shape":"Boolean", + "documentation":"Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.
" + } + }, + "documentation":"Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.
" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":402}, + "exception":true + }, + "SessionTTL":{ + "type":"integer", + "max":86400, + "min":60 + }, + "SkipResourceInUseCheck":{"type":"boolean"}, + "SlotConstraint":{ + "type":"string", + "enum":[ + "Required", + "Optional" + ] + }, + "SlotDefaultValue":{ + "type":"structure", + "required":["defaultValue"], + "members":{ + "defaultValue":{ + "shape":"SlotDefaultValueString", + "documentation":"The default value to use when a user doesn't provide a value for a slot.
" + } + }, + "documentation":"Specifies the default value to use when a user doesn't provide a value for a slot.
" + }, + "SlotDefaultValueList":{ + "type":"list", + "member":{"shape":"SlotDefaultValue"}, + "max":10, + "min":0 + }, + "SlotDefaultValueSpecification":{ + "type":"structure", + "required":["defaultValueList"], + "members":{ + "defaultValueList":{ + "shape":"SlotDefaultValueList", + "documentation":"A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
" + } + }, + "documentation":"Defines a list of values that Amazon Lex should use as the default value for a slot.
" + }, + "SlotDefaultValueString":{ + "type":"string", + "max":202, + "min":1 + }, + "SlotFilter":{ + "type":"structure", + "required":[ + "name", + "values", + "operator" + ], + "members":{ + "name":{ + "shape":"SlotFilterName", + "documentation":"The name of the field to use for filtering.
" + }, + "values":{ + "shape":"FilterValues", + "documentation":"The value to use to filter the response.
" + }, + "operator":{ + "shape":"SlotFilterOperator", + "documentation":"The operator to use for the filter. Specify EQ when the ListSlots operation should return only aliases that equal the specified value. Specify CO when the ListSlots operation should return aliases that contain the specified value.
Filters the response from the ListSlots operation.
The priority that a slot should be elicited.
" + }, + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier of the slot.
" + } + }, + "documentation":"Sets the priority that Amazon Lex should use when eliciting slot values from a user.
" + }, + "SlotSortAttribute":{ + "type":"string", + "enum":[ + "SlotName", + "LastUpdatedDateTime" + ] + }, + "SlotSortBy":{ + "type":"structure", + "required":[ + "attribute", + "order" + ], + "members":{ + "attribute":{ + "shape":"SlotSortAttribute", + "documentation":"The attribute to use to sort the list.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can choose ascending or descending.
" + } + }, + "documentation":"Specifies attributes for sorting a list of bots.
" + }, + "SlotSummary":{ + "type":"structure", + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier of the slot.
" + }, + "slotName":{ + "shape":"Name", + "documentation":"The name given to the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the slot.
" + }, + "slotConstraint":{ + "shape":"SlotConstraint", + "documentation":"Whether the slot is required or optional. An intent is complete when all required slots are filled.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The unique identifier for the slot type that defines the values for the slot.
" + }, + "valueElicitationPromptSpecification":{ + "shape":"PromptSpecification", + "documentation":"Prompts that are sent to the user to elicit a value for the slot.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the last date and time that the slot was updated.
" + } + }, + "documentation":"Summary information about a slot, a value that the bot elicits from the user.
" + }, + "SlotSummaryList":{ + "type":"list", + "member":{"shape":"SlotSummary"} + }, + "SlotTypeFilter":{ + "type":"structure", + "required":[ + "name", + "values", + "operator" + ], + "members":{ + "name":{ + "shape":"SlotTypeFilterName", + "documentation":"The name of the field to use for filtering.
" + }, + "values":{ + "shape":"FilterValues", + "documentation":"The value to use to filter the response.
" + }, + "operator":{ + "shape":"SlotTypeFilterOperator", + "documentation":"The operator to use for the filter. Specify EQ when the ListSlotTypes operation should return only aliases that equal the specified value. Specify CO when the ListSlotTypes operation should return aliases that contain the specified value.
Filters the response from the ListSlotTypes operation.
The attribute to use to sort the list of slot types.
" + }, + "order":{ + "shape":"SortOrder", + "documentation":"The order to sort the list. You can say ascending or descending.
" + } + }, + "documentation":"Specifies attributes for sorting a list of slot types.
" + }, + "SlotTypeSummary":{ + "type":"structure", + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The unique identifier assigned to the slot type.
" + }, + "slotTypeName":{ + "shape":"Name", + "documentation":"The name of the slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the slot type.
" + }, + "parentSlotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"If the slot type is derived from a built-on slot type, the name of the parent slot type.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot type was last updated.
" + } + }, + "documentation":"Provides summary information about a slot type.
" + }, + "SlotTypeSummaryList":{ + "type":"list", + "member":{"shape":"SlotTypeSummary"} + }, + "SlotTypeValue":{ + "type":"structure", + "members":{ + "sampleValue":{ + "shape":"SampleValue", + "documentation":"The value of the slot type entry.
" + }, + "synonyms":{ + "shape":"SynonymList", + "documentation":"Additional values releated to the slot type entry.
" + } + }, + "documentation":"Each slot type can have a set of values. Each SlotTypeValue represents a value that the slot type can take.
A list of default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, sesion attributes, and defined values.
" + }, + "slotConstraint":{ + "shape":"SlotConstraint", + "documentation":"Specifies whether the slot is required or optional.
" + }, + "promptSpecification":{ + "shape":"PromptSpecification", + "documentation":"The prompt that Amazon Lex uses to elicit the slot value from the user.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
" + }, + "waitAndContinueSpecification":{"shape":"WaitAndContinueSpecification"} + }, + "documentation":"Settings that you can use for eliciting a slot value.
" + }, + "SlotValueRegexFilter":{ + "type":"structure", + "required":["pattern"], + "members":{ + "pattern":{ + "shape":"RegexPattern", + "documentation":"A regular expression used to validate the value of a slot.
Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:
A-Z, a-z
0-9
Unicode characters (\"\\ u<Unicode>\")
Represent Unicode characters with four digits, for example \"\\u0041\" or \"\\u005A\".
The following regular expression operators are not supported:
Infinite repeaters: *, +, or {x,} with no upper bound.
Wild card (.)
Provides a regular expression used to validate the value of a slot.
" + }, + "SlotValueResolutionStrategy":{ + "type":"string", + "enum":[ + "OriginalValue", + "TopResolution" + ] + }, + "SlotValueSelectionSetting":{ + "type":"structure", + "required":["resolutionStrategy"], + "members":{ + "resolutionStrategy":{ + "shape":"SlotValueResolutionStrategy", + "documentation":"Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:
OriginalValue - Returns the value entered by the user, if the user value is similar to the slot value.
TopResolution - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.
If you don't specify the valueSelectionStrategy, the default is OriginalValue.
" + }, + "regexFilter":{ + "shape":"SlotValueRegexFilter", + "documentation":"A regular expression used to validate the value of a slot.
" + } + }, + "documentation":"Contains settings used by Amazon Lex to select a slot value.
" + }, + "SortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "StillWaitingResponseFrequency":{ + "type":"integer", + "max":300, + "min":1 + }, + "StillWaitingResponseSpecification":{ + "type":"structure", + "required":[ + "messageGroups", + "frequencyInSeconds", + "timeoutInSeconds" + ], + "members":{ + "messageGroups":{ + "shape":"MessageGroupsList", + "documentation":"One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
" + }, + "frequencyInSeconds":{ + "shape":"StillWaitingResponseFrequency", + "documentation":"How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
" + }, + "timeoutInSeconds":{ + "shape":"StillWaitingResponseTimeout", + "documentation":"If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
" + }, + "allowInterrupt":{ + "shape":"BoxedBoolean", + "documentation":"Indicates that the user can interrupt the response by speaking while the message is being played.
" + } + }, + "documentation":"Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.
" + }, + "StillWaitingResponseTimeout":{ + "type":"integer", + "max":900, + "min":1 + }, + "SynonymList":{ + "type":"list", + "member":{"shape":"SampleValue"}, + "max":10000, + "min":1 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceARN", + "tags" + ], + "members":{ + "resourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
", + "location":"uri", + "locationName":"resourceARN" + }, + "tags":{ + "shape":"TagMap", + "documentation":"A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.
" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TextLogDestination":{ + "type":"structure", + "required":["cloudWatch"], + "members":{ + "cloudWatch":{ + "shape":"CloudWatchLogGroupLogDestination", + "documentation":"Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.
" + } + }, + "documentation":"Defines the Amazon CloudWatch Logs destination log group for conversation text logs.
" + }, + "TextLogSetting":{ + "type":"structure", + "required":[ + "enabled", + "destination" + ], + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"Determines whether conversation logs should be stored for an alias.
" + }, + "destination":{"shape":"TextLogDestination"} + }, + "documentation":"Defines settings to enable text conversation logs.
" + }, + "TextLogSettingsList":{ + "type":"list", + "member":{"shape":"TextLogSetting"}, + "max":1, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceARN", + "tagKeys" + ], + "members":{ + "resourceARN":{ + "shape":"AmazonResourceName", + "documentation":"The Amazon Resource Name (ARN) of the resource to remove the tags from.
", + "location":"uri", + "locationName":"resourceARN" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBotAliasRequest":{ + "type":"structure", + "required":[ + "botAliasId", + "botAliasName", + "botId" + ], + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The unique identifier of the bot alias.
", + "location":"uri", + "locationName":"botAliasId" + }, + "botAliasName":{ + "shape":"Name", + "documentation":"The new name to assign to the bot alias.
" + }, + "description":{ + "shape":"Description", + "documentation":"The new description to assign to the bot alias.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The new bot version to assign to the bot alias.
" + }, + "botAliasLocaleSettings":{ + "shape":"BotAliasLocaleSettingsMap", + "documentation":"The new Lambda functions to use in each locale for the bot alias.
" + }, + "conversationLogSettings":{ + "shape":"ConversationLogSettings", + "documentation":"The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
" + }, + "sentimentAnalysisSettings":{"shape":"SentimentAnalysisSettings"}, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot with the updated alias.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "UpdateBotAliasResponse":{ + "type":"structure", + "members":{ + "botAliasId":{ + "shape":"BotAliasId", + "documentation":"The identifier of the updated bot alias.
" + }, + "botAliasName":{ + "shape":"Name", + "documentation":"The updated name of the bot alias.
" + }, + "description":{ + "shape":"Description", + "documentation":"The updated description of the bot alias.
" + }, + "botVersion":{ + "shape":"BotVersion", + "documentation":"The updated version of the bot that the alias points to.
" + }, + "botAliasLocaleSettings":{ + "shape":"BotAliasLocaleSettingsMap", + "documentation":"The updated Lambda functions to use in each locale for the bot alias.
" + }, + "conversationLogSettings":{ + "shape":"ConversationLogSettings", + "documentation":"The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.
" + }, + "sentimentAnalysisSettings":{"shape":"SentimentAnalysisSettings"}, + "botAliasStatus":{ + "shape":"BotAliasStatus", + "documentation":"The current status of the bot alias. When the status is Available the alias is ready for use.
The identifier of the bot with the updated alias.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot was last updated.
" + } + } + }, + "UpdateBotLocaleRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "nluIntentConfidenceThreshold" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that contains the locale.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.
The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "description":{ + "shape":"Description", + "documentation":"The new description of the locale.
" + }, + "nluIntentConfidenceThreshold":{ + "shape":"ConfidenceThreshold", + "documentation":"The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.
" + } + } + }, + "UpdateBotLocaleResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the updated locale.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the updated locale.
" + }, + "localeId":{ + "shape":"LocaleId", + "documentation":"The language and locale of the updated bot locale.
" + }, + "localeName":{ + "shape":"LocaleName", + "documentation":"The updated locale name for the locale.
" + }, + "description":{ + "shape":"Description", + "documentation":"The updated description of the locale.
" + }, + "nluIntentConfidenceThreshold":{ + "shape":"ConfidenceThreshold", + "documentation":"The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
The updated Amazon Polly voice to use for voice interaction with the user.
" + }, + "botLocaleStatus":{ + "shape":"BotLocaleStatus", + "documentation":"The current status of the locale. When the bot status is Built the locale is ready for use.
If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.
A timestamp of the date and time that the locale was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the locale was last updated.
" + } + } + }, + "UpdateBotRequest":{ + "type":"structure", + "required":[ + "botId", + "botName", + "roleArn", + "dataPrivacy", + "idleSessionTTLInSeconds" + ], + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.
", + "location":"uri", + "locationName":"botId" + }, + "botName":{ + "shape":"Name", + "documentation":"The new name of the bot. The name must be unique in the account that creates the bot.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the bot.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"Provides information on additional privacy protections Amazon Lex should use with the bot's data.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The time, in seconds, that Amazon Lex should keep information about a user's conversation with the bot.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.
You can specify between 60 (1 minute) and 86,400 (24 hours) seconds.
" + } + } + }, + "UpdateBotResponse":{ + "type":"structure", + "members":{ + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that was updated.
" + }, + "botName":{ + "shape":"Name", + "documentation":"The name of the bot after the update.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the bot after the update.
" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.
" + }, + "dataPrivacy":{ + "shape":"DataPrivacy", + "documentation":"The data privacy settings for the bot after the update.
" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"The session timeout, in seconds, for the bot after the update.
" + }, + "botStatus":{ + "shape":"BotStatus", + "documentation":"Shows the current status of the bot. The bot is first in the Creating status. Once the bot is read for use, it changes to the Available status. After the bot is created, you can use the DRAFT version of the bot.
A timestamp of the date and time that the bot was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the bot was last updated.
" + } + } + }, + "UpdateIntentRequest":{ + "type":"structure", + "required":[ + "intentId", + "intentName", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The unique identifier of the intent to update.
", + "location":"uri", + "locationName":"intentId" + }, + "intentName":{ + "shape":"Name", + "documentation":"The new name for the intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The new description of the intent.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"The signature of the new built-in intent to use as the parent of this intent.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"New utterances used to invoke the intent.
" + }, + "dialogCodeHook":{ + "shape":"DialogCodeHookSettings", + "documentation":"The new Lambda function to use between each turn of the conversation with the bot.
" + }, + "fulfillmentCodeHook":{ + "shape":"FulfillmentCodeHookSettings", + "documentation":"The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
" + }, + "slotPriorities":{ + "shape":"SlotPrioritiesList", + "documentation":"A new list of slots and their priorities that are contained by the intent.
" + }, + "intentConfirmationSetting":{ + "shape":"IntentConfirmationSetting", + "documentation":"New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
" + }, + "intentClosingSetting":{ + "shape":"IntentClosingSetting", + "documentation":"The new response that Amazon Lex sends the user when the intent is closed.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"A new list of contexts that must be active in order for Amazon Lex to consider the intent.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"A new list of contexts that Amazon Lex activates when the intent is fulfilled.
" + }, + "kendraConfiguration":{ + "shape":"KendraConfiguration", + "documentation":"New configuration settings for connecting to an Amazon Kendra index.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the intent.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the intent. Must be DRAFT.
The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "UpdateIntentResponse":{ + "type":"structure", + "members":{ + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent that was updated.
" + }, + "intentName":{ + "shape":"Name", + "documentation":"The updated name of the intent.
" + }, + "description":{ + "shape":"Description", + "documentation":"The updated description of the intent.
" + }, + "parentIntentSignature":{ + "shape":"IntentSignature", + "documentation":"The updated built-in intent that is the parent of this intent.
" + }, + "sampleUtterances":{ + "shape":"SampleUtterancesList", + "documentation":"The updated list of sample utterances for the intent.
" + }, + "dialogCodeHook":{ + "shape":"DialogCodeHookSettings", + "documentation":"The updated Lambda function called during each turn of the conversation with the user.
" + }, + "fulfillmentCodeHook":{ + "shape":"FulfillmentCodeHookSettings", + "documentation":"The updated Lambda function called when the intent is ready for fulfillment.
" + }, + "slotPriorities":{ + "shape":"SlotPrioritiesList", + "documentation":"The updated list of slots and their priorities that are elicited from the user for the intent.
" + }, + "intentConfirmationSetting":{ + "shape":"IntentConfirmationSetting", + "documentation":"The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
" + }, + "intentClosingSetting":{ + "shape":"IntentClosingSetting", + "documentation":"The updated response that Amazon Lex sends the user when the intent is closed.
" + }, + "inputContexts":{ + "shape":"InputContextsList", + "documentation":"The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
" + }, + "outputContexts":{ + "shape":"OutputContextsList", + "documentation":"The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
" + }, + "kendraConfiguration":{ + "shape":"KendraConfiguration", + "documentation":"The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.
The identifier of the bot that contains the intent.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the intent. Will always be DRAFT.
The updated language and locale of the intent.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of when the intent was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the last time that the intent was modified.
" + } + } + }, + "UpdateSlotRequest":{ + "type":"structure", + "required":[ + "slotId", + "slotName", + "slotTypeId", + "valueElicitationSetting", + "botId", + "botVersion", + "localeId", + "intentId" + ], + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier for the slot to update.
", + "location":"uri", + "locationName":"slotId" + }, + "slotName":{ + "shape":"Name", + "documentation":"The new name for the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The new description for the slot.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The unique identifier of the new slot type to associate with this slot.
" + }, + "valueElicitationSetting":{ + "shape":"SlotValueElicitationSetting", + "documentation":"A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
" + }, + "obfuscationSetting":{ + "shape":"ObfuscationSetting", + "documentation":"New settings that determine how slot values are formatted in Amazon CloudWatch logs.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The unique identifier of the bot that contains the slot.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the slot. Must always be DRAFT.
The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + }, + "intentId":{ + "shape":"Id", + "documentation":"The identifier of the intent that contains the slot.
", + "location":"uri", + "locationName":"intentId" + } + } + }, + "UpdateSlotResponse":{ + "type":"structure", + "members":{ + "slotId":{ + "shape":"Id", + "documentation":"The unique identifier of the slot that was updated.
" + }, + "slotName":{ + "shape":"Name", + "documentation":"The updated name of the slot.
" + }, + "description":{ + "shape":"Description", + "documentation":"The updated description of the bot.
" + }, + "slotTypeId":{ + "shape":"BuiltInOrCustomSlotTypeId", + "documentation":"The updated identifier of the slot type that provides values for the slot.
" + }, + "valueElicitationSetting":{ + "shape":"SlotValueElicitationSetting", + "documentation":"The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
" + }, + "obfuscationSetting":{ + "shape":"ObfuscationSetting", + "documentation":"The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the slot.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The identifier of the slot version that contains the slot. Will always be DRAFT.
The locale that contains the slot.
" + }, + "intentId":{ + "shape":"Id", + "documentation":"The intent that contains the slot.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the date and time that the slot was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the date and time that the slot was last updated.
" + } + } + }, + "UpdateSlotTypeRequest":{ + "type":"structure", + "required":[ + "slotTypeId", + "slotTypeName", + "valueSelectionSetting", + "botId", + "botVersion", + "localeId" + ], + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The unique identifier of the slot type to update.
", + "location":"uri", + "locationName":"slotTypeId" + }, + "slotTypeName":{ + "shape":"Name", + "documentation":"The new name of the slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The new description of the slot type.
" + }, + "slotTypeValues":{ + "shape":"SlotTypeValues", + "documentation":"A new list of values and their optional synonyms that define the values that the slot type can take.
" + }, + "valueSelectionSetting":{ + "shape":"SlotValueSelectionSetting", + "documentation":"The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.
" + }, + "parentSlotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"The new built-in slot type that should be used as the parent of this slot type.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the slot type.
", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the slot type. Must be DRAFT.
The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see https://docs.aws.amazon.com/lex/latest/dg/supported-locales.html.
", + "location":"uri", + "locationName":"localeId" + } + } + }, + "UpdateSlotTypeResponse":{ + "type":"structure", + "members":{ + "slotTypeId":{ + "shape":"Id", + "documentation":"The unique identifier of the updated slot type.
" + }, + "slotTypeName":{ + "shape":"Name", + "documentation":"The updated name of the slot type.
" + }, + "description":{ + "shape":"Description", + "documentation":"The updated description of the slot type.
" + }, + "slotTypeValues":{ + "shape":"SlotTypeValues", + "documentation":"The updated values that the slot type provides.
" + }, + "valueSelectionSetting":{ + "shape":"SlotValueSelectionSetting", + "documentation":"The updated strategy that Amazon Lex uses to determine which value to select from the slot type.
" + }, + "parentSlotTypeSignature":{ + "shape":"SlotTypeSignature", + "documentation":"The updated signature of the built-in slot type that is the parent of this slot type.
" + }, + "botId":{ + "shape":"Id", + "documentation":"The identifier of the bot that contains the slot type.
" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "documentation":"The version of the bot that contains the slot type. This is always DRAFT.
The language and locale of the updated slot type.
" + }, + "creationDateTime":{ + "shape":"Timestamp", + "documentation":"The timestamp of the date and time that the slot type was created.
" + }, + "lastUpdatedDateTime":{ + "shape":"Timestamp", + "documentation":"A timestamp of the date and time that the slot type was last updated.
" + } + } + }, + "Utterance":{"type":"string"}, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Value":{ + "type":"string", + "max":140, + "min":1 + }, + "VoiceId":{"type":"string"}, + "VoiceSettings":{ + "type":"structure", + "required":["voiceId"], + "members":{ + "voiceId":{ + "shape":"VoiceId", + "documentation":"The identifier of the Amazon Polly voice to use.
" + } + }, + "documentation":"Defines settings for using an Amazon Polly voice to communicate with a user.
" + }, + "WaitAndContinueSpecification":{ + "type":"structure", + "required":[ + "waitingResponse", + "continueResponse" + ], + "members":{ + "waitingResponse":{ + "shape":"ResponseSpecification", + "documentation":"The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
" + }, + "continueResponse":{ + "shape":"ResponseSpecification", + "documentation":"The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
" + }, + "stillWaitingResponse":{ + "shape":"StillWaitingResponseSpecification", + "documentation":"A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
" + } + }, + "documentation":"Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
" + } + }, + "documentation":"" +} From 3beda63b56458a49d63950554f7d1c54c48bb2e0 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:12:56 +0000 Subject: [PATCH 7/9] Amazon Relational Database Service Update: Documentation updates for Amazon RDS --- ...azonRelationalDatabaseService-b711a3d.json | 6 ++++ .../codegen-resources/service-2.json | 28 +++++++++---------- 2 files changed, 20 insertions(+), 14 deletions(-) create mode 100644 .changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json diff --git a/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json b/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json new file mode 100644 index 000000000000..53b6c9f56d76 --- /dev/null +++ b/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Relational Database Service", + "contributor": "", + "description": "Documentation updates for Amazon RDS" +} diff --git a/services/rds/src/main/resources/codegen-resources/service-2.json b/services/rds/src/main/resources/codegen-resources/service-2.json index 52b9ed812d93..b5cfb72cc1c7 100755 --- a/services/rds/src/main/resources/codegen-resources/service-2.json +++ b/services/rds/src/main/resources/codegen-resources/service-2.json @@ -2987,7 +2987,7 @@ "members":{ "SourceDBClusterParameterGroupIdentifier":{ "shape":"String", - "documentation":"The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
Must specify a valid DB cluster parameter group.
If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.
If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.
Constraints:
Must specify a valid DB cluster parameter group.
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
Constraints:
Must specify a valid DB parameter group.
The DB engine mode of the DB cluster, either provisioned serverless, parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can't be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.
Default: ORCL
Constraints:
Can't be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" + "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
" }, "EnableCustomerOwnedIp":{ "shape":"BooleanOptional", @@ -3753,7 +3753,7 @@ }, "MaxAllocatedStorage":{ "shape":"IntegerOptional", - "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" + "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
" } } }, @@ -4044,7 +4044,7 @@ }, "EngineName":{ "shape":"String", - "documentation":"Specifies the name of the engine that this option group should be associated with.
" + "documentation":"Specifies the name of the engine that this option group should be associated with.
Valid Values:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The database engine to return.
" + "documentation":"The database engine to return.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
A required parameter. Options available for the given engine name are described.
" + "documentation":"A required parameter. Options available for the given engine name are described.
Valid Values:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Filters the list of option groups to only include groups associated with a specific database engine.
" + "documentation":"Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The name of the engine to retrieve DB instance options for.
" + "documentation":"The name of the engine to retrieve DB instance options for.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" + "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
" }, "CertificateRotationRestart":{ "shape":"BooleanOptional", @@ -11839,7 +11839,7 @@ }, "MaxAllocatedStorage":{ "shape":"IntegerOptional", - "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" + "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
" } } }, @@ -11976,7 +11976,7 @@ }, "MaxAllocatedStorage":{ "shape":"IntegerOptional", - "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
" + "documentation":"The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
" }, "SourceDBInstanceAutomatedBackupsArn":{ "shape":"String", From 54b9c99eb03a03107d3e1431a8728ee23bf5d8ec Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:12:47 +0000 Subject: [PATCH 8/9] Amazon Redshift Update: Update VPC endpoint field names. --- .../feature-AmazonRedshift-38967a9.json | 6 ++++ .../codegen-resources/service-2.json | 36 +++++++++---------- 2 files changed, 24 insertions(+), 18 deletions(-) create mode 100644 .changes/next-release/feature-AmazonRedshift-38967a9.json diff --git a/.changes/next-release/feature-AmazonRedshift-38967a9.json b/.changes/next-release/feature-AmazonRedshift-38967a9.json new file mode 100644 index 000000000000..ea3dd795755d --- /dev/null +++ b/.changes/next-release/feature-AmazonRedshift-38967a9.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Redshift", + "contributor": "", + "description": "Update VPC endpoint field names." +} diff --git a/services/redshift/src/main/resources/codegen-resources/service-2.json b/services/redshift/src/main/resources/codegen-resources/service-2.json index 8393abd3599a..4ee9baaa1c54 100644 --- a/services/redshift/src/main/resources/codegen-resources/service-2.json +++ b/services/redshift/src/main/resources/codegen-resources/service-2.json @@ -4610,7 +4610,7 @@ "documentation":"The port that the database engine is listening on.
" }, "VpcEndpoints":{ - "shape":"SpartaProxyVpcEndpointList", + "shape":"VpcEndpointsList", "documentation":"Describes a connection endpoint.
" } }, @@ -7724,23 +7724,6 @@ "scheduled-action" ] }, - "SpartaProxyVpcEndpoint":{ - "type":"structure", - "members":{ - "VpcEndpointId":{ - "shape":"String", - "documentation":"The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
" - } - }, - "documentation":"The connection endpoint for connecting an Amazon Redshift cluster through the proxy.
" - }, - "SpartaProxyVpcEndpointList":{ - "type":"list", - "member":{ - "shape":"SpartaProxyVpcEndpoint", - "locationName":"SpartaProxyVpcEndpoint" - } - }, "String":{ "type":"string", "max":2147483647 @@ -8291,6 +8274,23 @@ "locationName":"item" } }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
" + } + }, + "documentation":"The connection endpoint for connecting an Amazon Redshift cluster through the proxy.
" + }, + "VpcEndpointsList":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"VpcEndpoint" + } + }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ From 813d6741a3cef0fd3283b94d46838925340559e2 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Fri, 22 Jan 2021 19:15:47 +0000 Subject: [PATCH 9/9] Release 2.15.69. Updated CHANGELOG.md, README.md and all pom.xml. --- .changes/2.15.69.json | 48 +++++++++++++++++++ .../feature-AWSIoTGreengrassV2-691896e.json | 6 --- ...ure-AmazonElasticComputeCloud-c9e706f.json | 6 --- ...ture-AmazonLexModelBuildingV2-33a4057.json | 6 --- .../feature-AmazonLexRuntimeV2-a823e3d.json | 6 --- .../feature-AmazonRedshift-38967a9.json | 6 --- ...azonRelationalDatabaseService-b711a3d.json | 6 --- ...AmazonSimpleSystemsManagerSSM-e555db5.json | 6 --- CHANGELOG.md | 29 +++++++++++ README.md | 8 ++-- archetypes/archetype-lambda/pom.xml | 2 +- archetypes/pom.xml | 2 +- aws-sdk-java/pom.xml | 12 ++++- bom-internal/pom.xml | 2 +- bom/pom.xml | 12 ++++- bundle/pom.xml | 2 +- codegen-lite-maven-plugin/pom.xml | 2 +- codegen-lite/pom.xml | 2 +- codegen-maven-plugin/pom.xml | 2 +- codegen/pom.xml | 2 +- core/annotations/pom.xml | 2 +- core/arns/pom.xml | 2 +- core/auth/pom.xml | 2 +- core/aws-core/pom.xml | 2 +- core/metrics-spi/pom.xml | 2 +- core/pom.xml | 2 +- core/profiles/pom.xml | 2 +- core/protocols/aws-cbor-protocol/pom.xml | 2 +- core/protocols/aws-ion-protocol/pom.xml | 2 +- core/protocols/aws-json-protocol/pom.xml | 2 +- core/protocols/aws-query-protocol/pom.xml | 2 +- core/protocols/aws-xml-protocol/pom.xml | 2 +- core/protocols/pom.xml | 2 +- core/protocols/protocol-core/pom.xml | 2 +- core/regions/pom.xml | 2 +- core/sdk-core/pom.xml | 2 +- http-client-spi/pom.xml | 2 +- http-clients/apache-client/pom.xml | 2 +- http-clients/aws-crt-client/pom.xml | 2 +- http-clients/netty-nio-client/pom.xml | 2 +- http-clients/pom.xml | 2 +- http-clients/url-connection-client/pom.xml | 2 +- .../cloudwatch-metric-publisher/pom.xml | 2 +- metric-publishers/pom.xml | 2 +- pom.xml | 2 +- release-scripts/pom.xml | 2 +- services-custom/dynamodb-enhanced/pom.xml | 2 +- services-custom/pom.xml | 2 +- services/accessanalyzer/pom.xml | 2 +- services/acm/pom.xml | 2 +- services/acmpca/pom.xml | 2 +- services/alexaforbusiness/pom.xml | 2 +- services/amp/pom.xml | 2 +- services/amplify/pom.xml | 2 +- services/amplifybackend/pom.xml | 2 +- services/apigateway/pom.xml | 2 +- services/apigatewaymanagementapi/pom.xml | 2 +- services/apigatewayv2/pom.xml | 2 +- services/appconfig/pom.xml | 2 +- services/appflow/pom.xml | 2 +- services/appintegrations/pom.xml | 2 +- services/applicationautoscaling/pom.xml | 2 +- services/applicationdiscovery/pom.xml | 2 +- services/applicationinsights/pom.xml | 2 +- services/appmesh/pom.xml | 2 +- services/appstream/pom.xml | 2 +- services/appsync/pom.xml | 2 +- services/athena/pom.xml | 2 +- services/auditmanager/pom.xml | 2 +- services/autoscaling/pom.xml | 2 +- services/autoscalingplans/pom.xml | 2 +- services/backup/pom.xml | 2 +- services/batch/pom.xml | 2 +- services/braket/pom.xml | 2 +- services/budgets/pom.xml | 2 +- services/chime/pom.xml | 2 +- services/cloud9/pom.xml | 2 +- services/clouddirectory/pom.xml | 2 +- services/cloudformation/pom.xml | 2 +- services/cloudfront/pom.xml | 2 +- services/cloudhsm/pom.xml | 2 +- services/cloudhsmv2/pom.xml | 2 +- services/cloudsearch/pom.xml | 2 +- services/cloudsearchdomain/pom.xml | 2 +- services/cloudtrail/pom.xml | 2 +- services/cloudwatch/pom.xml | 2 +- services/cloudwatchevents/pom.xml | 2 +- services/cloudwatchlogs/pom.xml | 2 +- services/codeartifact/pom.xml | 2 +- services/codebuild/pom.xml | 2 +- services/codecommit/pom.xml | 2 +- services/codedeploy/pom.xml | 2 +- services/codeguruprofiler/pom.xml | 2 +- services/codegurureviewer/pom.xml | 2 +- services/codepipeline/pom.xml | 2 +- services/codestar/pom.xml | 2 +- services/codestarconnections/pom.xml | 2 +- services/codestarnotifications/pom.xml | 2 +- services/cognitoidentity/pom.xml | 2 +- services/cognitoidentityprovider/pom.xml | 2 +- services/cognitosync/pom.xml | 2 +- services/comprehend/pom.xml | 2 +- services/comprehendmedical/pom.xml | 2 +- services/computeoptimizer/pom.xml | 2 +- services/config/pom.xml | 2 +- services/connect/pom.xml | 2 +- services/connectcontactlens/pom.xml | 2 +- services/connectparticipant/pom.xml | 2 +- services/costandusagereport/pom.xml | 2 +- services/costexplorer/pom.xml | 2 +- services/customerprofiles/pom.xml | 2 +- services/databasemigration/pom.xml | 2 +- services/databrew/pom.xml | 2 +- services/dataexchange/pom.xml | 2 +- services/datapipeline/pom.xml | 2 +- services/datasync/pom.xml | 2 +- services/dax/pom.xml | 2 +- services/detective/pom.xml | 2 +- services/devicefarm/pom.xml | 2 +- services/devopsguru/pom.xml | 2 +- services/directconnect/pom.xml | 2 +- services/directory/pom.xml | 2 +- services/dlm/pom.xml | 2 +- services/docdb/pom.xml | 2 +- services/dynamodb/pom.xml | 2 +- services/ebs/pom.xml | 2 +- services/ec2/pom.xml | 2 +- services/ec2instanceconnect/pom.xml | 2 +- services/ecr/pom.xml | 2 +- services/ecrpublic/pom.xml | 2 +- services/ecs/pom.xml | 2 +- services/efs/pom.xml | 2 +- services/eks/pom.xml | 2 +- services/elasticache/pom.xml | 2 +- services/elasticbeanstalk/pom.xml | 2 +- services/elasticinference/pom.xml | 2 +- services/elasticloadbalancing/pom.xml | 2 +- services/elasticloadbalancingv2/pom.xml | 2 +- services/elasticsearch/pom.xml | 2 +- services/elastictranscoder/pom.xml | 2 +- services/emr/pom.xml | 2 +- services/emrcontainers/pom.xml | 2 +- services/eventbridge/pom.xml | 2 +- services/firehose/pom.xml | 2 +- services/fms/pom.xml | 2 +- services/forecast/pom.xml | 2 +- services/forecastquery/pom.xml | 2 +- services/frauddetector/pom.xml | 2 +- services/fsx/pom.xml | 2 +- services/gamelift/pom.xml | 2 +- services/glacier/pom.xml | 2 +- services/globalaccelerator/pom.xml | 2 +- services/glue/pom.xml | 2 +- services/greengrass/pom.xml | 2 +- services/greengrassv2/pom.xml | 2 +- services/groundstation/pom.xml | 2 +- services/guardduty/pom.xml | 2 +- services/health/pom.xml | 2 +- services/healthlake/pom.xml | 2 +- services/honeycode/pom.xml | 2 +- services/iam/pom.xml | 2 +- services/identitystore/pom.xml | 2 +- services/imagebuilder/pom.xml | 2 +- services/inspector/pom.xml | 2 +- services/iot/pom.xml | 2 +- services/iot1clickdevices/pom.xml | 2 +- services/iot1clickprojects/pom.xml | 2 +- services/iotanalytics/pom.xml | 2 +- services/iotdataplane/pom.xml | 2 +- services/iotdeviceadvisor/pom.xml | 2 +- services/iotevents/pom.xml | 2 +- services/ioteventsdata/pom.xml | 2 +- services/iotfleethub/pom.xml | 2 +- services/iotjobsdataplane/pom.xml | 2 +- services/iotsecuretunneling/pom.xml | 2 +- services/iotsitewise/pom.xml | 2 +- services/iotthingsgraph/pom.xml | 2 +- services/iotwireless/pom.xml | 2 +- services/ivs/pom.xml | 2 +- services/kafka/pom.xml | 2 +- services/kendra/pom.xml | 2 +- services/kinesis/pom.xml | 2 +- services/kinesisanalytics/pom.xml | 2 +- services/kinesisanalyticsv2/pom.xml | 2 +- services/kinesisvideo/pom.xml | 2 +- services/kinesisvideoarchivedmedia/pom.xml | 2 +- services/kinesisvideomedia/pom.xml | 2 +- services/kinesisvideosignaling/pom.xml | 2 +- services/kms/pom.xml | 2 +- services/lakeformation/pom.xml | 2 +- services/lambda/pom.xml | 2 +- services/lexmodelbuilding/pom.xml | 2 +- services/lexmodelsv2/pom.xml | 2 +- services/lexruntime/pom.xml | 2 +- services/lexruntimev2/pom.xml | 2 +- services/licensemanager/pom.xml | 2 +- services/lightsail/pom.xml | 2 +- services/location/pom.xml | 2 +- services/lookoutvision/pom.xml | 2 +- services/machinelearning/pom.xml | 2 +- services/macie/pom.xml | 2 +- services/macie2/pom.xml | 2 +- services/managedblockchain/pom.xml | 2 +- services/marketplacecatalog/pom.xml | 2 +- services/marketplacecommerceanalytics/pom.xml | 2 +- services/marketplaceentitlement/pom.xml | 2 +- services/marketplacemetering/pom.xml | 2 +- services/mediaconnect/pom.xml | 2 +- services/mediaconvert/pom.xml | 2 +- services/medialive/pom.xml | 2 +- services/mediapackage/pom.xml | 2 +- services/mediapackagevod/pom.xml | 2 +- services/mediastore/pom.xml | 2 +- services/mediastoredata/pom.xml | 2 +- services/mediatailor/pom.xml | 2 +- services/migrationhub/pom.xml | 2 +- services/migrationhubconfig/pom.xml | 2 +- services/mobile/pom.xml | 2 +- services/mq/pom.xml | 2 +- services/mturk/pom.xml | 2 +- services/mwaa/pom.xml | 2 +- services/neptune/pom.xml | 2 +- services/networkfirewall/pom.xml | 2 +- services/networkmanager/pom.xml | 2 +- services/opsworks/pom.xml | 2 +- services/opsworkscm/pom.xml | 2 +- services/organizations/pom.xml | 2 +- services/outposts/pom.xml | 2 +- services/personalize/pom.xml | 2 +- services/personalizeevents/pom.xml | 2 +- services/personalizeruntime/pom.xml | 2 +- services/pi/pom.xml | 2 +- services/pinpoint/pom.xml | 2 +- services/pinpointemail/pom.xml | 2 +- services/pinpointsmsvoice/pom.xml | 2 +- services/polly/pom.xml | 2 +- services/pom.xml | 4 +- services/pricing/pom.xml | 2 +- services/qldb/pom.xml | 2 +- services/qldbsession/pom.xml | 2 +- services/quicksight/pom.xml | 2 +- services/ram/pom.xml | 2 +- services/rds/pom.xml | 2 +- services/rdsdata/pom.xml | 2 +- services/redshift/pom.xml | 2 +- services/redshiftdata/pom.xml | 2 +- services/rekognition/pom.xml | 2 +- services/resourcegroups/pom.xml | 2 +- services/resourcegroupstaggingapi/pom.xml | 2 +- services/robomaker/pom.xml | 2 +- services/route53/pom.xml | 2 +- services/route53domains/pom.xml | 2 +- services/route53resolver/pom.xml | 2 +- services/s3/pom.xml | 2 +- services/s3control/pom.xml | 2 +- services/s3outposts/pom.xml | 2 +- services/sagemaker/pom.xml | 2 +- services/sagemakera2iruntime/pom.xml | 2 +- services/sagemakeredge/pom.xml | 2 +- services/sagemakerfeaturestoreruntime/pom.xml | 2 +- services/sagemakerruntime/pom.xml | 2 +- services/savingsplans/pom.xml | 2 +- services/schemas/pom.xml | 2 +- services/secretsmanager/pom.xml | 2 +- services/securityhub/pom.xml | 2 +- .../serverlessapplicationrepository/pom.xml | 2 +- services/servicecatalog/pom.xml | 2 +- services/servicecatalogappregistry/pom.xml | 2 +- services/servicediscovery/pom.xml | 2 +- services/servicequotas/pom.xml | 2 +- services/ses/pom.xml | 2 +- services/sesv2/pom.xml | 2 +- services/sfn/pom.xml | 2 +- services/shield/pom.xml | 2 +- services/signer/pom.xml | 2 +- services/sms/pom.xml | 2 +- services/snowball/pom.xml | 2 +- services/sns/pom.xml | 2 +- services/sqs/pom.xml | 2 +- services/ssm/pom.xml | 2 +- services/sso/pom.xml | 2 +- services/ssoadmin/pom.xml | 2 +- services/ssooidc/pom.xml | 2 +- services/storagegateway/pom.xml | 2 +- services/sts/pom.xml | 2 +- services/support/pom.xml | 2 +- services/swf/pom.xml | 2 +- services/synthetics/pom.xml | 2 +- services/textract/pom.xml | 2 +- services/timestreamquery/pom.xml | 2 +- services/timestreamwrite/pom.xml | 2 +- services/transcribe/pom.xml | 2 +- services/transcribestreaming/pom.xml | 2 +- services/transfer/pom.xml | 2 +- services/translate/pom.xml | 2 +- services/waf/pom.xml | 2 +- services/wafv2/pom.xml | 2 +- services/wellarchitected/pom.xml | 2 +- services/workdocs/pom.xml | 2 +- services/worklink/pom.xml | 2 +- services/workmail/pom.xml | 2 +- services/workmailmessageflow/pom.xml | 2 +- services/workspaces/pom.xml | 2 +- services/xray/pom.xml | 2 +- test/codegen-generated-classes-test/pom.xml | 2 +- test/http-client-tests/pom.xml | 2 +- test/module-path-tests/pom.xml | 2 +- test/protocol-tests-core/pom.xml | 2 +- test/protocol-tests/pom.xml | 2 +- test/sdk-benchmarks/pom.xml | 2 +- test/service-test-utils/pom.xml | 2 +- test/stability-tests/pom.xml | 2 +- test/test-utils/pom.xml | 2 +- test/tests-coverage-reporting/pom.xml | 2 +- utils/pom.xml | 2 +- 315 files changed, 408 insertions(+), 351 deletions(-) create mode 100644 .changes/2.15.69.json delete mode 100644 .changes/next-release/feature-AWSIoTGreengrassV2-691896e.json delete mode 100644 .changes/next-release/feature-AmazonElasticComputeCloud-c9e706f.json delete mode 100644 .changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json delete mode 100644 .changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json delete mode 100644 .changes/next-release/feature-AmazonRedshift-38967a9.json delete mode 100644 .changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json delete mode 100644 .changes/next-release/feature-AmazonSimpleSystemsManagerSSM-e555db5.json diff --git a/.changes/2.15.69.json b/.changes/2.15.69.json new file mode 100644 index 000000000000..98f2ae843e51 --- /dev/null +++ b/.changes/2.15.69.json @@ -0,0 +1,48 @@ +{ + "version": "2.15.69", + "date": "2021-01-22", + "entries": [ + { + "type": "feature", + "category": "Amazon Elastic Compute Cloud", + "contributor": "", + "description": "Introducing startDate field for CapacityReservation object for the date and time which the reservation started and adding reserved parameter for ModifyCapacityReservation." + }, + { + "type": "feature", + "category": "Amazon Lex Model Building V2", + "contributor": "", + "description": "This release adds support for Amazon Lex V2 APIs for model building." + }, + { + "type": "feature", + "category": "Amazon Simple Systems Manager (SSM)", + "contributor": "", + "description": "Documentation updates for the ListDocumentFilters API action." + }, + { + "type": "feature", + "category": "Amazon Redshift", + "contributor": "", + "description": "Update VPC endpoint field names." + }, + { + "type": "feature", + "category": "Amazon Relational Database Service", + "contributor": "", + "description": "Documentation updates for Amazon RDS" + }, + { + "type": "feature", + "category": "AWS IoT Greengrass V2", + "contributor": "", + "description": "Documentation updates that improve clarity and fix broken links." + }, + { + "type": "feature", + "category": "Amazon Lex Runtime V2", + "contributor": "", + "description": "This release adds support for Amazon Lex V2 APIs for runtime, including Streaming APIs for conversation management." + } + ] +} \ No newline at end of file diff --git a/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json b/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json deleted file mode 100644 index 076f17032dfb..000000000000 --- a/.changes/next-release/feature-AWSIoTGreengrassV2-691896e.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "AWS IoT Greengrass V2", - "contributor": "", - "description": "Documentation updates that improve clarity and fix broken links." -} diff --git a/.changes/next-release/feature-AmazonElasticComputeCloud-c9e706f.json b/.changes/next-release/feature-AmazonElasticComputeCloud-c9e706f.json deleted file mode 100644 index 5d0c07905df5..000000000000 --- a/.changes/next-release/feature-AmazonElasticComputeCloud-c9e706f.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Elastic Compute Cloud", - "contributor": "", - "description": "Introducing startDate field for CapacityReservation object for the date and time which the reservation started and adding reserved parameter for ModifyCapacityReservation." -} diff --git a/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json b/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json deleted file mode 100644 index a4a167384d58..000000000000 --- a/.changes/next-release/feature-AmazonLexModelBuildingV2-33a4057.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Lex Model Building V2", - "contributor": "", - "description": "This release adds support for Amazon Lex V2 APIs for model building." -} diff --git a/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json b/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json deleted file mode 100644 index 6b4ae1844a17..000000000000 --- a/.changes/next-release/feature-AmazonLexRuntimeV2-a823e3d.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Lex Runtime V2", - "contributor": "", - "description": "This release adds support for Amazon Lex V2 APIs for runtime, including Streaming APIs for conversation management." -} diff --git a/.changes/next-release/feature-AmazonRedshift-38967a9.json b/.changes/next-release/feature-AmazonRedshift-38967a9.json deleted file mode 100644 index ea3dd795755d..000000000000 --- a/.changes/next-release/feature-AmazonRedshift-38967a9.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Redshift", - "contributor": "", - "description": "Update VPC endpoint field names." -} diff --git a/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json b/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json deleted file mode 100644 index 53b6c9f56d76..000000000000 --- a/.changes/next-release/feature-AmazonRelationalDatabaseService-b711a3d.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Relational Database Service", - "contributor": "", - "description": "Documentation updates for Amazon RDS" -} diff --git a/.changes/next-release/feature-AmazonSimpleSystemsManagerSSM-e555db5.json b/.changes/next-release/feature-AmazonSimpleSystemsManagerSSM-e555db5.json deleted file mode 100644 index 6ff11631819e..000000000000 --- a/.changes/next-release/feature-AmazonSimpleSystemsManagerSSM-e555db5.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "type": "feature", - "category": "Amazon Simple Systems Manager (SSM)", - "contributor": "", - "description": "Documentation updates for the ListDocumentFilters API action." -} diff --git a/CHANGELOG.md b/CHANGELOG.md index 369975c04590..b4e7b6fb1375 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,32 @@ +# __2.15.69__ __2021-01-22__ +## __AWS IoT Greengrass V2__ + - ### Features + - Documentation updates that improve clarity and fix broken links. + +## __Amazon Elastic Compute Cloud__ + - ### Features + - Introducing startDate field for CapacityReservation object for the date and time which the reservation started and adding reserved parameter for ModifyCapacityReservation. + +## __Amazon Lex Model Building V2__ + - ### Features + - This release adds support for Amazon Lex V2 APIs for model building. + +## __Amazon Lex Runtime V2__ + - ### Features + - This release adds support for Amazon Lex V2 APIs for runtime, including Streaming APIs for conversation management. + +## __Amazon Redshift__ + - ### Features + - Update VPC endpoint field names. + +## __Amazon Relational Database Service__ + - ### Features + - Documentation updates for Amazon RDS + +## __Amazon Simple Systems Manager (SSM)__ + - ### Features + - Documentation updates for the ListDocumentFilters API action. + # __2.15.68__ __2021-01-21__ ## __AWS Resource Groups Tagging API__ - ### Features diff --git a/README.md b/README.md index 83cab2e322a5..dffdfcea0da6 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ To automatically manage module versions (currently all modules have the same ver