AWS SDK for PHP 3.x
  • Namespace
  • Class
Did this page help you? SUBMIT FEEDBACK!

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Schemas
      • Exception
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\NimbleStudio\NimbleStudioClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Schemas\SchemasClient
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

  • Aws\AwsClientInterface
  • Aws\CacheInterface
  • Aws\ClientSideMonitoring\ConfigurationInterface
  • Aws\CommandInterface
  • Aws\ConfigurationProviderInterface
  • Aws\Credentials\CredentialsInterface
  • Aws\Crypto\AesStreamInterface
  • Aws\Crypto\AesStreamInterfaceV2
  • Aws\Crypto\Cipher\CipherMethod
  • Aws\Crypto\MaterialsProviderInterface
  • Aws\Crypto\MaterialsProviderInterfaceV2
  • Aws\Crypto\MetadataStrategyInterface
  • Aws\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • Aws\EndpointDiscovery\ConfigurationInterface
  • Aws\HashInterface
  • Aws\MonitoringEventsInterface
  • Aws\ResponseContainerInterface
  • Aws\ResultInterface
  • Aws\Retry\ConfigurationInterface
  • Aws\S3\RegionalEndpoint\ConfigurationInterface
  • Aws\S3\S3ClientInterface
  • Aws\S3\UseArnRegion\ConfigurationInterface
  • Aws\Signature\SignatureInterface
  • Aws\Sts\RegionalEndpoints\ConfigurationInterface

Traits

  • Aws\Api\ErrorParser\JsonParserTrait
  • Aws\Api\Parser\MetadataParserTrait
  • Aws\Api\Parser\PayloadParserTrait
  • Aws\AwsClientTrait
  • Aws\Crypto\Cipher\CipherBuilderTrait
  • Aws\Crypto\DecryptionTrait
  • Aws\Crypto\DecryptionTraitV2
  • Aws\Crypto\EncryptionTrait
  • Aws\Crypto\EncryptionTraitV2
  • Aws\Crypto\Polyfill\NeedsTrait
  • Aws\DynamoDb\SessionConnectionConfigTrait
  • Aws\HasDataTrait
  • Aws\HasMonitoringEventsTrait
  • Aws\Retry\RetryHelperTrait
  • Aws\S3\CalculatesChecksumTrait
  • Aws\S3\Crypto\CryptoParamsTrait
  • Aws\S3\Crypto\CryptoParamsTraitV2
  • Aws\S3\Crypto\UserAgentTrait
  • Aws\S3\MultipartUploadingTrait
  • Aws\S3\S3ClientTrait
  • Aws\Signature\SignatureTrait

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\BackupGateway\Exception\BackupGatewayException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DefaultsMode\Exception\ConfigurationException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\drs\Exception\drsException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\NimbleStudio\Exception\NimbleStudioException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

  • Aws\boolean_value
  • Aws\clear_compiled_json
  • Aws\constantly
  • Aws\default_http_handler
  • Aws\default_user_agent
  • Aws\describe_type
  • Aws\dir_iterator
  • Aws\filter
  • Aws\flatmap
  • Aws\guzzle_major_version
  • Aws\is_fips_pseudo_region
  • Aws\is_valid_epoch
  • Aws\is_valid_hostlabel
  • Aws\is_valid_hostname
  • Aws\load_compiled_json
  • Aws\manifest
  • Aws\map
  • Aws\or_chain
  • Aws\parse_ini_file
  • Aws\partition
  • Aws\recursive_dir_iterator
  • Aws\serialize
  • Aws\strip_fips_pseudo_regions

Amazon Lex Model Building V2 2020-08-07

Client: Aws\LexModelsV2\LexModelsV2Client
Service ID: models.lex.v2
Version: 2020-08-07

This page describes the parameters and results for the operations of the Amazon Lex Model Building V2 (2020-08-07), and shows how to use the Aws\LexModelsV2\LexModelsV2Client object to call the described operations. This documentation is specific to the 2020-08-07 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

  • BuildBotLocale ( array $params = [] )

    Builds a bot, its intents, and its slot types into a specific locale.

  • CreateBot ( array $params = [] )

    Creates an Amazon Lex conversational bot.

  • CreateBotAlias ( array $params = [] )

    Creates an alias for the specified version of a bot.

  • CreateBotLocale ( array $params = [] )

    Creates a locale in the bot.

  • CreateBotVersion ( array $params = [] )

    Creates a new version of the bot based on the DRAFT version.

  • CreateExport ( array $params = [] )

    Creates a zip archive containing the contents of a bot or a bot locale.

  • CreateIntent ( array $params = [] )

    Creates an intent.

  • CreateResourcePolicy ( array $params = [] )

    Creates a new resource policy with the specified policy statements.

  • CreateResourcePolicyStatement ( array $params = [] )

    Adds a new resource policy statement to a bot or bot alias.

  • CreateSlot ( array $params = [] )

    Creates a slot in an intent.

  • CreateSlotType ( array $params = [] )

    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.

  • CreateUploadUrl ( array $params = [] )

    Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

  • DeleteBot ( array $params = [] )

    Deletes all versions of a bot, including the Draft version.

  • DeleteBotAlias ( array $params = [] )

    Deletes the specified bot alias.

  • DeleteBotLocale ( array $params = [] )

    Removes a locale from a bot.

  • DeleteBotVersion ( array $params = [] )

    Deletes a specific version of a bot.

  • DeleteCustomVocabulary ( array $params = [] )

    Removes a custom vocabulary from the specified locale in the specified bot.

  • DeleteExport ( array $params = [] )

    Removes a previous export and the associated files stored in an S3 bucket.

  • DeleteImport ( array $params = [] )

    Removes a previous import and the associated file stored in an S3 bucket.

  • DeleteIntent ( array $params = [] )

    Removes the specified intent.

  • DeleteResourcePolicy ( array $params = [] )

    Removes an existing policy from a bot or bot alias.

  • DeleteResourcePolicyStatement ( array $params = [] )

    Deletes a policy statement from a resource policy.

  • DeleteSlot ( array $params = [] )

    Deletes the specified slot from an intent.

  • DeleteSlotType ( array $params = [] )

    Deletes a slot type from a bot locale.

  • DeleteUtterances ( array $params = [] )

    Deletes stored utterances.

  • DescribeBot ( array $params = [] )

    Provides metadata information about a bot.

  • DescribeBotAlias ( array $params = [] )

    Get information about a specific bot alias.

  • DescribeBotLocale ( array $params = [] )

    Describes the settings that a bot has for a specific locale.

  • DescribeBotRecommendation ( array $params = [] )

    Provides metadata information about a bot recommendation.

  • DescribeBotVersion ( array $params = [] )

    Provides metadata about a version of a bot.

  • DescribeCustomVocabularyMetadata ( array $params = [] )

    Provides metadata information about a custom vocabulary.

  • DescribeExport ( array $params = [] )

    Gets information about a specific export.

  • DescribeImport ( array $params = [] )

    Gets information about a specific import.

  • DescribeIntent ( array $params = [] )

    Returns metadata about an intent.

  • DescribeResourcePolicy ( array $params = [] )

    Gets the resource policy and policy revision for a bot or bot alias.

  • DescribeSlot ( array $params = [] )

    Gets metadata information about a slot.

  • DescribeSlotType ( array $params = [] )

    Gets metadata information about a slot type.

  • ListAggregatedUtterances ( array $params = [] )

    Provides a list of utterances that users have sent to the bot.

  • ListBotAliases ( array $params = [] )

    Gets a list of aliases for the specified bot.

  • ListBotLocales ( array $params = [] )

    Gets a list of locales for the specified bot.

  • ListBotRecommendations ( array $params = [] )

    Get a list of bot recommendations that meet the specified criteria.

  • ListBotVersions ( array $params = [] )

    Gets information about all of the versions of a bot.

  • ListBots ( array $params = [] )

    Gets a list of available bots.

  • ListBuiltInIntents ( array $params = [] )

    Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

  • ListBuiltInSlotTypes ( array $params = [] )

    Gets a list of built-in slot types that meet the specified criteria.

  • ListExports ( array $params = [] )

    Lists the exports for a bot, bot locale, or custom vocabulary.

  • ListImports ( array $params = [] )

    Lists the imports for a bot, bot locale, or custom vocabulary.

  • ListIntents ( array $params = [] )

    Get a list of intents that meet the specified criteria.

  • ListRecommendedIntents ( array $params = [] )

    Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.

  • ListSlotTypes ( array $params = [] )

    Gets a list of slot types that match the specified criteria.

  • ListSlots ( array $params = [] )

    Gets a list of slots that match the specified criteria.

  • ListTagsForResource ( array $params = [] )

    Gets a list of tags associated with a resource.

  • SearchAssociatedTranscripts ( array $params = [] )

    Search for associated transcripts that meet the specified criteria.

  • StartBotRecommendation ( array $params = [] )

    Use this to provide your transcript data, and to start the bot recommendation process.

  • StartImport ( array $params = [] )

    Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

  • TagResource ( array $params = [] )

    Adds the specified tags to the specified resource.

  • UntagResource ( array $params = [] )

    Removes tags from a bot, bot alias, or bot channel.

  • UpdateBot ( array $params = [] )

    Updates the configuration of an existing bot.

  • UpdateBotAlias ( array $params = [] )

    Updates the configuration of an existing bot alias.

  • UpdateBotLocale ( array $params = [] )

    Updates the settings that a bot has for a specific locale.

  • UpdateBotRecommendation ( array $params = [] )

    Updates an existing bot recommendation request.

  • UpdateExport ( array $params = [] )

    Updates the password used to protect an export zip archive.

  • UpdateIntent ( array $params = [] )

    Updates the settings for an intent.

  • UpdateResourcePolicy ( array $params = [] )

    Replaces the existing resource policy for a bot or bot alias with a new one.

  • UpdateSlot ( array $params = [] )

    Updates the settings for a slot.

  • UpdateSlotType ( array $params = [] )

    Updates the configuration of an existing slot type.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

  • ListAggregatedUtterances
  • ListBotAliases
  • ListBotLocales
  • ListBotRecommendations
  • ListBotVersions
  • ListBots
  • ListBuiltInIntents
  • ListBuiltInSlotTypes
  • ListExports
  • ListImports
  • ListIntents
  • ListRecommendedIntents
  • ListSlotTypes
  • ListSlots

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name API Operation Delay Max Attempts
BotAvailable DescribeBot 10 35
BotAliasAvailable DescribeBotAlias 10 35
BotExportCompleted DescribeExport 10 35
BotImportCompleted DescribeImport 10 35
BotLocaleBuilt DescribeBotLocale 10 35
BotLocaleExpressTestingAvailable DescribeBotLocale 10 35
BotVersionAvailable DescribeBotVersion 10 35
BotLocaleCreated DescribeBotLocale 10 35

Operations

BuildBotLocale

$result = $client->buildBotLocale([/* ... */]);
$promise = $client->buildBotLocaleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->buildBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to build. This can only be the draft version of the bot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'lastBuildSubmittedDateTime' => <DateTime>,
    'localeId' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the specified bot.

botLocaleStatus
  • Type: string

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.

botVersion
  • Type: string

The version of the bot that was built. This is only the draft version of the bot.

lastBuildSubmittedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating the date and time that the bot was last built for this locale.

localeId
  • Type: string

The language and locale specified of where the bot can be used.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateBot

$result = $client->createBot([/* ... */]);
$promise = $client->createBotAsync([/* ... */]);

Creates an Amazon Lex conversational bot.

Parameter Syntax

$result = $client->createBot([
    'botName' => '<string>', // REQUIRED
    'botTags' => ['<string>', ...],
    'dataPrivacy' => [ // REQUIRED
        'childDirected' => true || false, // REQUIRED
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>, // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'testBotAliasTags' => ['<string>', ...],
]);

Parameter Details

Members
botName
  • Required: Yes
  • Type: string

The name of the bot. The bot name must be unique in the account that creates the bot.

botTags
  • Type: Associative array of custom strings keys (TagKey) to strings

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.

dataPrivacy
  • Required: Yes
  • Type: DataPrivacy structure

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

description
  • Type: string

A description of the bot. It appears in lists to help you identify a particular bot.

idleSessionTTLInSeconds
  • Required: Yes
  • Type: int

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.

roleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

testBotAliasTags
  • Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'botId' => '<string>',
    'botName' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botTags' => ['<string>', ...],
    'creationDateTime' => <DateTime>,
    'dataPrivacy' => [
        'childDirected' => true || false,
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'roleArn' => '<string>',
    'testBotAliasTags' => ['<string>', ...],
]

Result Details

Members
botId
  • Type: string

A unique identifier for a particular bot. You use this to identify the bot when you call other Amazon Lex API operations.

botName
  • Type: string

The name specified for the bot.

botStatus
  • Type: string

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.

botTags
  • Type: Associative array of custom strings keys (TagKey) to strings

A list of tags associated with the bot.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating the date and time that the bot was created.

dataPrivacy
  • Type: DataPrivacy structure

The data privacy settings specified for the bot.

description
  • Type: string

The description specified for the bot.

idleSessionTTLInSeconds
  • Type: int

The session idle time specified for the bot.

roleArn
  • Type: string

The IAM role specified for the bot.

testBotAliasTags
  • Type: Associative array of custom strings keys (TagKey) to strings

A list of tags associated with the test alias for the bot.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateBotAlias

$result = $client->createBotAlias([/* ... */]);
$promise = $client->createBotAliasAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createBotAlias([
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [ // REQUIRED
                    'codeHookInterfaceVersion' => '<string>', // REQUIRED
                    'lambdaARN' => '<string>', // REQUIRED
                ],
            ],
            'enabled' => true || false, // REQUIRED
        ],
        // ...
    ],
    'botAliasName' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    's3Bucket' => [ // REQUIRED
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>', // REQUIRED
                        's3BucketArn' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    'cloudWatch' => [ // REQUIRED
                        'cloudWatchLogGroupArn' => '<string>', // REQUIRED
                        'logPrefix' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false, // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
botAliasLocaleSettings
  • Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures

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.

botAliasName
  • Required: Yes
  • Type: string

The alias to create. The name must be unique for the bot.

botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that the alias applies to.

botVersion
  • Type: string

The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

conversationLogSettings
  • Type: ConversationLogSettings structure

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.

description
  • Type: string

A description of the alias. Use this description to help identify the alias.

sentimentAnalysisSettings
  • Type: SentimentAnalysisSettings structure

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

tags
  • Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'botAliasId' => '<string>',
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [
                    'codeHookInterfaceVersion' => '<string>',
                    'lambdaARN' => '<string>',
                ],
            ],
            'enabled' => true || false,
        ],
        // ...
    ],
    'botAliasName' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [
                    's3Bucket' => [
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>',
                        's3BucketArn' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [
                    'cloudWatch' => [
                        'cloudWatchLogGroupArn' => '<string>',
                        'logPrefix' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false,
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
botAliasId
  • Type: string

The unique identifier of the bot alias.

botAliasLocaleSettings
  • Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures

Configuration information for a specific locale.

botAliasName
  • Type: string

The name specified for the bot alias.

botAliasStatus
  • Type: string

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.

botId
  • Type: string

The unique identifier of the bot that this alias applies to.

botVersion
  • Type: string

The version of the bot associated with this alias.

conversationLogSettings
  • Type: ConversationLogSettings structure

The conversation log settings specified for the alias.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A Unix timestamp indicating the date and time that the bot alias was created.

description
  • Type: string

The description specified for the bot alias.

sentimentAnalysisSettings
  • Type: SentimentAnalysisSettings structure

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

tags
  • Type: Associative array of custom strings keys (TagKey) to strings

A list of tags associated with the bot alias.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateBotLocale

$result = $client->createBotLocale([/* ... */]);
$promise = $client->createBotLocaleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'localeId' => '<string>', // REQUIRED
    'nluIntentConfidenceThreshold' => <float>, // REQUIRED
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to create the locale for.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to create the locale for. This can only be the draft version of the bot.

description
  • Type: string

A description of the bot locale. Use this to help identify the bot locale in lists.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

nluIntentConfidenceThreshold
  • Required: Yes
  • Type: double

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 RecognizeText operation would be:

  • AMAZON.FallbackIntent

  • IntentA

  • IntentB

  • IntentC

voiceSettings
  • Type: VoiceSettings structure

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'localeId' => '<string>',
    'localeName' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>',
    ],
]

Result Details

Members
botId
  • Type: string

The specified bot identifier.

botLocaleStatus
  • Type: string

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.

botVersion
  • Type: string

The specified bot version.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp specifying the date and time that the bot locale was created.

description
  • Type: string

The specified description of the bot locale.

localeId
  • Type: string

The specified locale identifier.

localeName
  • Type: string

The specified locale name.

nluIntentConfidenceThreshold
  • Type: double

The specified confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents.

voiceSettings
  • Type: VoiceSettings structure

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateBotVersion

$result = $client->createBotVersion([/* ... */]);
$promise = $client->createBotVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createBotVersion([
    'botId' => '<string>', // REQUIRED
    'botVersionLocaleSpecification' => [ // REQUIRED
        '<LocaleId>' => [
            'sourceBotVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to create the version for.

botVersionLocaleSpecification
  • Required: Yes
  • Type: Associative array of custom strings keys (LocaleId) to BotVersionLocaleDetails structures

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.

description
  • Type: string

A description of the version. Use the description to help identify the version in lists.

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botVersion' => '<string>',
    'botVersionLocaleSpecification' => [
        '<LocaleId>' => [
            'sourceBotVersion' => '<string>',
        ],
        // ...
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
]

Result Details

Members
botId
  • Type: string

The bot identifier specified in the request.

botStatus
  • Type: string

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.

botVersion
  • Type: string

The version number assigned to the version.

botVersionLocaleSpecification
  • Type: Associative array of custom strings keys (LocaleId) to BotVersionLocaleDetails structures

The source versions used for each locale in the new version.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the version was created.

description
  • Type: string

The description of the version specified in the request.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateExport

$result = $client->createExport([/* ... */]);
$promise = $client->createExportAsync([/* ... */]);

Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.

You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.

For more information about exporting bots, and about the structure of the export archive, see Importing and exporting bots

Parameter Syntax

$result = $client->createExport([
    'fileFormat' => 'LexJson|TSV', // REQUIRED
    'filePassword' => '<string>',
    'resourceSpecification' => [ // REQUIRED
        'botExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
fileFormat
  • Required: Yes
  • Type: string

The file format of the bot or bot locale definition files.

filePassword
  • Type: string

An password to use to encrypt the exported archive. Using a password is optional, but you should encrypt the archive to protect the data in transit between Amazon Lex and your local computer.

resourceSpecification
  • Required: Yes
  • Type: ExportResourceSpecification structure

Specifies the type of resource to export, either a bot or a bot locale. You can only specify one type of resource to export.

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
    'fileFormat' => 'LexJson|TSV',
    'resourceSpecification' => [
        'botExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the request to export a bot was created.

exportId
  • Type: string

An identifier for a specific request to create an export.

exportStatus
  • Type: string

The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

fileFormat
  • Type: string

The file format used for the bot or bot locale definition files.

resourceSpecification
  • Type: ExportResourceSpecification structure

A description of the type of resource that was exported, either a bot or a bot locale.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateIntent

$result = $client->createIntent([/* ... */]);
$promise = $client->createIntentAsync([/* ... */]);

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?"

Parameter Syntax

$result = $client->createIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false, // REQUIRED
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false, // REQUIRED
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false, // REQUIRED
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentName' => '<string>', // REQUIRED
    'kendraConfiguration' => [
        'kendraIndex' => '<string>', // REQUIRED
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'localeId' => '<string>', // REQUIRED
    'outputContexts' => [
        [
            'name' => '<string>', // REQUIRED
            'timeToLiveInSeconds' => <integer>, // REQUIRED
            'turnsToLive' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with this intent.

botVersion
  • Required: Yes
  • Type: string

The identifier of the version of the bot associated with this intent.

description
  • Type: string

A description of the intent. Use the description to help identify the intent in lists.

dialogCodeHook
  • Type: DialogCodeHookSettings structure

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.

fulfillmentCodeHook
  • Type: FulfillmentCodeHookSettings structure

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.

inputContexts
  • Type: Array of InputContext structures

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.

intentClosingSetting
  • Type: IntentClosingSetting structure

Sets the response that Amazon Lex sends to the user when the intent is closed.

intentConfirmationSetting
  • Type: IntentConfirmationSetting structure

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.

intentName
  • Required: Yes
  • Type: string

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.

kendraConfiguration
  • Type: KendraConfiguration structure

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.

localeId
  • Required: Yes
  • Type: string

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. For more information, see Supported languages.

outputContexts
  • Type: Array of OutputContext structures

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.

parentIntentSignature
  • Type: string

A unique identifier for the built-in intent to base this intent on.

sampleUtterances
  • Type: Array of SampleUtterance structures

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..

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false,
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false,
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false,
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentId' => '<string>',
    'intentName' => '<string>',
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'localeId' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the intent.

botVersion
  • Type: string

The identifier of the version of the bot associated with the intent.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the intent was created.

description
  • Type: string

The description specified for the intent.

dialogCodeHook
  • Type: DialogCodeHookSettings structure

The dialog Lambda function specified for the intent.

fulfillmentCodeHook
  • Type: FulfillmentCodeHookSettings structure

The fulfillment Lambda function specified for the intent.

inputContexts
  • Type: Array of InputContext structures

The list of input contexts specified for the intent.

intentClosingSetting
  • Type: IntentClosingSetting structure

The closing setting specified for the intent.

intentConfirmationSetting
  • Type: IntentConfirmationSetting structure

The confirmation setting specified for the intent.

intentId
  • Type: string

A unique identifier for the intent.

intentName
  • Type: string

The name specified for the intent.

kendraConfiguration
  • Type: KendraConfiguration structure

Configuration for searching a Amazon Kendra index specified for the intent.

localeId
  • Type: string

The locale that the intent is specified to use.

outputContexts
  • Type: Array of OutputContext structures

The list of output contexts specified for the intent.

parentIntentSignature
  • Type: string

The signature of the parent intent specified for the intent.

sampleUtterances
  • Type: Array of SampleUtterance structures

The sample utterances specified for the intent.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateResourcePolicy

$result = $client->createResourcePolicy([/* ... */]);
$promise = $client->createResourcePolicyAsync([/* ... */]);

Creates a new resource policy with the specified policy statements.

Parameter Syntax

$result = $client->createResourcePolicy([
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
policy
  • Required: Yes
  • Type: string

A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

If the policy isn't valid, Amazon Lex returns a validation exception.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

CreateResourcePolicyStatement

$result = $client->createResourcePolicyStatement([/* ... */]);
$promise = $client->createResourcePolicyStatementAsync([/* ... */]);

Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.

You can't create a resource policy statement that allows cross-account access.

Parameter Syntax

$result = $client->createResourcePolicyStatement([
    'action' => ['<string>', ...], // REQUIRED
    'condition' => [
        '<ConditionOperator>' => ['<string>', ...],
        // ...
    ],
    'effect' => 'Allow|Deny', // REQUIRED
    'expectedRevisionId' => '<string>',
    'principal' => [ // REQUIRED
        [
            'arn' => '<string>',
            'service' => '<string>',
        ],
        // ...
    ],
    'resourceArn' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Members
action
  • Required: Yes
  • Type: Array of strings

The Amazon Lex action that this policy either allows or denies. The action must apply to the resource type of the specified ARN. For more information, see Actions, resources, and condition keys for Amazon Lex V2.

condition
  • Type: Associative array of custom strings keys (ConditionOperator) to stringss

Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.

For more information, see IAM JSON policy elements: Condition .

effect
  • Required: Yes
  • Type: string

Determines whether the statement allows or denies access to the resource.

expectedRevisionId
  • Type: string

The identifier of the revision of the policy to edit. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

principal
  • Required: Yes
  • Type: Array of Principal structures

An IAM principal, such as an IAM users, IAM roles, or AWS services that is allowed or denied access to a resource. For more information, see AWS JSON policy elements: Principal.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

statementId
  • Required: Yes
  • Type: string

The name of the statement. The ID is the same as the Sid IAM property. The statement name must be unique within the policy. For more information, see IAM JSON policy elements: Sid.

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

CreateSlot

$result = $client->createSlot([/* ... */]);
$promise = $client->createSlotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation', // REQUIRED
    ],
    'slotName' => '<string>', // REQUIRED
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [ // REQUIRED
        'defaultValueSpecification' => [
            'defaultValueList' => [ // REQUIRED
                [
                    'defaultValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional', // REQUIRED
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>, // REQUIRED
            ],
            'waitingResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the slot.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the slot.

description
  • Type: string

A description of the slot. Use this to help identify the slot in lists.

intentId
  • Required: Yes
  • Type: string

The identifier of the intent that contains the slot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

multipleValuesSetting
  • Type: MultipleValuesSetting structure

Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.

obfuscationSetting
  • Type: ObfuscationSetting structure

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.

slotName
  • Required: Yes
  • Type: string

The name of the slot. Slot names must be unique within the bot that contains the slot.

slotTypeId
  • Type: string

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
  • Required: Yes
  • Type: SlotValueElicitationSetting structure

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'intentId' => '<string>',
    'localeId' => '<string>',
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation',
    ],
    'slotId' => '<string>',
    'slotName' => '<string>',
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [
        'defaultValueSpecification' => [
            'defaultValueList' => [
                [
                    'defaultValue' => '<string>',
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>',
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional',
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'waitingResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot associated with the slot.

botVersion
  • Type: string

The version of the bot associated with the slot.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the date and time that the slot was created.

description
  • Type: string

The description associated with the slot.

intentId
  • Type: string

The unique identifier of the intent associated with the slot.

localeId
  • Type: string

The language and local specified for the slot.

multipleValuesSetting
  • Type: MultipleValuesSetting structure

Indicates whether the slot returns multiple values in one response.

obfuscationSetting
  • Type: ObfuscationSetting structure

Indicates whether the slot is configured to obfuscate values in Amazon CloudWatch logs.

slotId
  • Type: string

The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.

slotName
  • Type: string

The name specified for the slot.

slotTypeId
  • Type: string

The unique identifier of the slot type associated with this slot.

valueElicitationSetting
  • Type: SlotValueElicitationSetting structure

The value elicitation settings specified for the slot.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateSlotType

$result = $client->createSlotType([/* ... */]);
$promise = $client->createSlotTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>', // REQUIRED
                's3ObjectKey' => '<string>', // REQUIRED
            ],
        ],
    ],
    'localeId' => '<string>', // REQUIRED
    'parentSlotTypeSignature' => '<string>',
    'slotTypeName' => '<string>', // REQUIRED
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>', // REQUIRED
            ],
            'synonyms' => [
                [
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>', // REQUIRED
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with this slot type.

botVersion
  • Required: Yes
  • Type: string

The identifier of the bot version associated with this slot type.

description
  • Type: string

A description of the slot type. Use the description to help identify the slot type in lists.

externalSourceSetting
  • Type: ExternalSourceSetting structure

Sets the type of external information used to create the slot type.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

parentSlotTypeSignature
  • Type: string

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.

slotTypeName
  • Required: Yes
  • Type: string

The name for the slot. A slot type name must be unique within the account.

slotTypeValues
  • Type: Array of SlotTypeValue structures

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.

valueSelectionSetting
  • Type: SlotValueSelectionSetting structure

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.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
    ],
    'localeId' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeId' => '<string>',
    'slotTypeName' => '<string>',
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>',
            ],
            'synonyms' => [
                [
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>',
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution',
    ],
]

Result Details

Members
botId
  • Type: string

The identifier for the bot associated with the slot type.

botVersion
  • Type: string

The version of the bot associated with the slot type.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot type was created.

description
  • Type: string

The description specified for the slot type.

externalSourceSetting
  • Type: ExternalSourceSetting structure

The type of external information used to create the slot type.

localeId
  • Type: string

The specified language and local specified for the slot type.

parentSlotTypeSignature
  • Type: string

The signature of the base slot type specified for the slot type.

slotTypeId
  • Type: string

The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

slotTypeName
  • Type: string

The name specified for the slot type.

slotTypeValues
  • Type: Array of SlotTypeValue structures

The list of values that the slot type can assume.

valueSelectionSetting
  • Type: SlotValueSelectionSetting structure

The strategy that Amazon Lex uses to select a value from the list of possible values.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

CreateUploadUrl

$result = $client->createUploadUrl([/* ... */]);
$promise = $client->createUploadUrlAsync([/* ... */]);

Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale.

Parameter Syntax

$result = $client->createUploadUrl([
]);

Parameter Details

Members

Result Syntax

[
    'importId' => '<string>',
    'uploadUrl' => '<string>',
]

Result Details

Members
importId
  • Type: string

An identifier for a unique import job. Use it when you call the StartImport operation.

uploadUrl
  • Type: string

A pre-signed S3 write URL. Upload the zip archive file that contains the definition of your bot or bot locale.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteBot

$result = $client->deleteBot([/* ... */]);
$promise = $client->deleteBotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteBot([
    'botId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to delete.

skipResourceInUseCheck
  • Type: boolean

When true, Amazon Lex doesn't check to see if another resource, such as an alias, is using the bot before it is deleted.

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot that Amazon Lex is deleting.

botStatus
  • Type: string

The current status of the bot. The status is Deleting while the bot and its associated resources are being deleted.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteBotAlias

$result = $client->deleteBotAlias([/* ... */]);
$promise = $client->deleteBotAliasAsync([/* ... */]);

Deletes the specified bot alias.

Parameter Syntax

$result = $client->deleteBotAlias([
    'botAliasId' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Members
botAliasId
  • Required: Yes
  • Type: string

The unique identifier of the bot alias to delete.

botId
  • Required: Yes
  • Type: string

The unique identifier of the bot associated with the alias to delete.

skipResourceInUseCheck
  • Type: boolean

When this parameter is true, Amazon Lex doesn't check to see if any other resource is using the alias before it is deleted.

Result Syntax

[
    'botAliasId' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
]

Result Details

Members
botAliasId
  • Type: string

The unique identifier of the bot alias to delete.

botAliasStatus
  • Type: string

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.

botId
  • Type: string

The unique identifier of the bot that contains the alias to delete.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteBotLocale

$result = $client->deleteBotLocale([/* ... */]);
$promise = $client->deleteBotLocaleAsync([/* ... */]);

Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

Parameter Syntax

$result = $client->deleteBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the locale.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the locale.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'localeId' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contained the deleted locale.

botLocaleStatus
  • Type: string

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.

botVersion
  • Type: string

The version of the bot that contained the deleted locale.

localeId
  • Type: string

The language and locale of the deleted locale.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteBotVersion

$result = $client->deleteBotVersion([/* ... */]);
$promise = $client->deleteBotVersionAsync([/* ... */]);

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

Parameter Syntax

$result = $client->deleteBotVersion([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot that contains the version.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to delete.

skipResourceInUseCheck
  • Type: boolean

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.

Result Syntax

[
    'botId' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botVersion' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that is being deleted.

botStatus
  • Type: string

The current status of the bot.

botVersion
  • Type: string

The version of the bot that is being deleted.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteCustomVocabulary

$result = $client->deleteCustomVocabulary([/* ... */]);
$promise = $client->deleteCustomVocabularyAsync([/* ... */]);

Removes a custom vocabulary from the specified locale in the specified bot.

Parameter Syntax

$result = $client->deleteCustomVocabulary([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot to remove the custom vocabulary from.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to remove the custom vocabulary from.

localeId
  • Required: Yes
  • Type: string

The locale identifier for the locale that contains the custom vocabulary to remove.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'customVocabularyStatus' => 'Ready|Deleting|Exporting|Importing|Creating',
    'localeId' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that the custom vocabulary was removed from.

botVersion
  • Type: string

The version of the bot that the custom vocabulary was removed from.

customVocabularyStatus
  • Type: string

The status of removing the custom vocabulary.

localeId
  • Type: string

The locale identifier for the locale that the custom vocabulary was removed from.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteExport

$result = $client->deleteExport([/* ... */]);
$promise = $client->deleteExportAsync([/* ... */]);

Removes a previous export and the associated files stored in an S3 bucket.

Parameter Syntax

$result = $client->deleteExport([
    'exportId' => '<string>', // REQUIRED
]);

Parameter Details

Members
exportId
  • Required: Yes
  • Type: string

The unique identifier of the export to delete.

Result Syntax

[
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
]

Result Details

Members
exportId
  • Type: string

The unique identifier of the deleted export.

exportStatus
  • Type: string

The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteImport

$result = $client->deleteImport([/* ... */]);
$promise = $client->deleteImportAsync([/* ... */]);

Removes a previous import and the associated file stored in an S3 bucket.

Parameter Syntax

$result = $client->deleteImport([
    'importId' => '<string>', // REQUIRED
]);

Parameter Details

Members
importId
  • Required: Yes
  • Type: string

The unique identifier of the import to delete.

Result Syntax

[
    'importId' => '<string>',
    'importStatus' => 'InProgress|Completed|Failed|Deleting',
]

Result Details

Members
importId
  • Type: string

The unique identifier of the deleted import.

importStatus
  • Type: string

The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteIntent

$result = $client->deleteIntent([/* ... */]);
$promise = $client->deleteIntentAsync([/* ... */]);

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.

Parameter Syntax

$result = $client->deleteIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the intent.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the intent.

intentId
  • Required: Yes
  • Type: string

The unique identifier of the intent to delete.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'expectedRevisionId' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
expectedRevisionId
  • Type: string

The identifier of the revision to edit. If this ID doesn't match the current revision number, Amazon Lex returns an exception

If you don't specify a revision ID, Amazon Lex will delete the current policy.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

DeleteResourcePolicyStatement

$result = $client->deleteResourcePolicyStatement([/* ... */]);
$promise = $client->deleteResourcePolicyStatementAsync([/* ... */]);

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

Parameter Syntax

$result = $client->deleteResourcePolicyStatement([
    'expectedRevisionId' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Members
expectedRevisionId
  • Type: string

The identifier of the revision of the policy to delete the statement from. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

If you don't specify a revision, Amazon Lex removes the current contents of the statement.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

statementId
  • Required: Yes
  • Type: string

The name of the statement (SID) to delete from the policy.

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

DeleteSlot

$result = $client->deleteSlot([/* ... */]);
$promise = $client->deleteSlotAsync([/* ... */]);

Deletes the specified slot from an intent.

Parameter Syntax

$result = $client->deleteSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'slotId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the slot to delete.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the slot to delete.

intentId
  • Required: Yes
  • Type: string

The identifier of the intent associated with the slot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

slotId
  • Required: Yes
  • Type: string

The identifier of the slot to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteSlotType

$result = $client->deleteSlotType([/* ... */]);
$promise = $client->deleteSlotTypeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'skipResourceInUseCheck' => true || false,
    'slotTypeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the slot type.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the slot type.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

skipResourceInUseCheck
  • Type: boolean

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.

slotTypeId
  • Required: Yes
  • Type: string

The identifier of the slot type to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DeleteUtterances

$result = $client->deleteUtterances([/* ... */]);
$promise = $client->deleteUtterancesAsync([/* ... */]);

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

Parameter Syntax

$result = $client->deleteUtterances([
    'botId' => '<string>', // REQUIRED
    'localeId' => '<string>',
    'sessionId' => '<string>',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the utterances.

localeId
  • Type: string

The identifier of the language and locale where the utterances were collected. The string must match one of the supported locales. For more information, see Supported languages.

sessionId
  • Type: string

The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeBot

$result = $client->describeBot([/* ... */]);
$promise = $client->describeBotAsync([/* ... */]);

Provides metadata information about a bot.

Parameter Syntax

$result = $client->describeBot([
    'botId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot to describe.

Result Syntax

[
    'botId' => '<string>',
    'botName' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'creationDateTime' => <DateTime>,
    'dataPrivacy' => [
        'childDirected' => true || false,
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'lastUpdatedDateTime' => <DateTime>,
    'roleArn' => '<string>',
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot.

botName
  • Type: string

The name of the bot.

botStatus
  • Type: string

The current status of the bot. When the status is Available the bot is ready to be used in conversations with users.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was created.

dataPrivacy
  • Type: DataPrivacy structure

Settings for managing data privacy of the bot and its conversations with users.

description
  • Type: string

The description of the bot.

idleSessionTTLInSeconds
  • Type: int

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was last updated.

roleArn
  • Type: string

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeBotAlias

$result = $client->describeBotAlias([/* ... */]);
$promise = $client->describeBotAliasAsync([/* ... */]);

Get information about a specific bot alias.

Parameter Syntax

$result = $client->describeBotAlias([
    'botAliasId' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botAliasId
  • Required: Yes
  • Type: string

The identifier of the bot alias to describe.

botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the bot alias to describe.

Result Syntax

[
    'botAliasHistoryEvents' => [
        [
            'botVersion' => '<string>',
            'endDate' => <DateTime>,
            'startDate' => <DateTime>,
        ],
        // ...
    ],
    'botAliasId' => '<string>',
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [
                    'codeHookInterfaceVersion' => '<string>',
                    'lambdaARN' => '<string>',
                ],
            ],
            'enabled' => true || false,
        ],
        // ...
    ],
    'botAliasName' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [
                    's3Bucket' => [
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>',
                        's3BucketArn' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [
                    'cloudWatch' => [
                        'cloudWatchLogGroupArn' => '<string>',
                        'logPrefix' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedDateTime' => <DateTime>,
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false,
    ],
]

Result Details

Members
botAliasHistoryEvents
  • Type: Array of BotAliasHistoryEvent structures

A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

botAliasId
  • Type: string

The identifier of the bot alias.

botAliasLocaleSettings
  • Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures

The locale settings that are unique to the alias.

botAliasName
  • Type: string

The name of the bot alias.

botAliasStatus
  • Type: string

The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

botId
  • Type: string

The identifier of the bot associated with the bot alias.

botVersion
  • Type: string

The version of the bot associated with the bot alias.

conversationLogSettings
  • Type: ConversationLogSettings structure

Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the alias was created.

description
  • Type: string

The description of the bot alias.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the alias was last updated.

sentimentAnalysisSettings
  • Type: SentimentAnalysisSettings structure

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeBotLocale

$result = $client->describeBotLocale([/* ... */]);
$promise = $client->describeBotLocaleAsync([/* ... */]);

Describes the settings that a bot has for a specific locale.

Parameter Syntax

$result = $client->describeBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the locale.

botVersion
  • Required: Yes
  • Type: string

The identifier of the version of the bot associated with the locale.

localeId
  • Required: Yes
  • Type: string

The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see Supported languages.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleHistoryEvents' => [
        [
            'event' => '<string>',
            'eventDate' => <DateTime>,
        ],
        // ...
    ],
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'failureReasons' => ['<string>', ...],
    'intentsCount' => <integer>,
    'lastBuildSubmittedDateTime' => <DateTime>,
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'localeName' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'recommendedActions' => ['<string>', ...],
    'slotTypesCount' => <integer>,
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>',
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the locale.

botLocaleHistoryEvents
  • Type: Array of BotLocaleHistoryEvent structures

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

botLocaleStatus
  • Type: string

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

botVersion
  • Type: string

The identifier of the version of the bot associated with the locale.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the locale was created.

description
  • Type: string

The description of the locale.

failureReasons
  • Type: Array of strings

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

intentsCount
  • Type: int

The number of intents defined for the locale.

lastBuildSubmittedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the locale was last submitted for building.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the locale was last updated.

localeId
  • Type: string

The unique identifier of the described locale.

localeName
  • Type: string

The name of the locale.

nluIntentConfidenceThreshold
  • Type: double

The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

recommendedActions
  • Type: Array of strings

Recommended actions to take to resolve an error in the failureReasons field.

slotTypesCount
  • Type: int

The number of slot types defined for the locale.

voiceSettings
  • Type: VoiceSettings structure

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeBotRecommendation

$result = $client->describeBotRecommendation([/* ... */]);
$promise = $client->describeBotRecommendationAsync([/* ... */]);

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Parameter Syntax

$result = $client->describeBotRecommendation([
    'botId' => '<string>', // REQUIRED
    'botRecommendationId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot associated with the bot recommendation.

botRecommendationId
  • Required: Yes
  • Type: string

The identifier of the bot recommendation to describe.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the bot recommendation.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the bot recommendation to describe. The string must match one of the supported locales. For more information, see Supported languages.

Result Syntax

[
    'botId' => '<string>',
    'botRecommendationId' => '<string>',
    'botRecommendationResults' => [
        'associatedTranscriptsUrl' => '<string>',
        'botLocaleExportUrl' => '<string>',
        'statistics' => [
            'intents' => [
                'discoveredIntentCount' => <integer>,
            ],
            'slotTypes' => [
                'discoveredSlotTypeCount' => <integer>,
            ],
        ],
    ],
    'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'encryptionSetting' => [
        'associatedTranscriptsPassword' => '<string>',
        'botLocaleExportPassword' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'failureReasons' => ['<string>', ...],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'transcriptSourceSetting' => [
        's3BucketTranscriptSource' => [
            'kmsKeyArn' => '<string>',
            'pathFormat' => [
                'objectPrefixes' => ['<string>', ...],
            ],
            's3BucketName' => '<string>',
            'transcriptFilter' => [
                'lexTranscriptFilter' => [
                    'dateRangeFilter' => [
                        'endDateTime' => <DateTime>,
                        'startDateTime' => <DateTime>,
                    ],
                ],
            ],
            'transcriptFormat' => 'Lex',
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the bot recommendation.

botRecommendationId
  • Type: string

The identifier of the bot recommendation being described.

botRecommendationResults
  • Type: BotRecommendationResults structure

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

botRecommendationStatus
  • Type: string

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

botVersion
  • Type: string

The version of the bot associated with the bot recommendation.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the bot recommendation was created.

encryptionSetting
  • Type: EncryptionSetting structure

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

failureReasons
  • Type: Array of strings

If botRecommendationStatus is Failed, Amazon Lex explains why.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the bot recommendation was last updated.

localeId
  • Type: string

The identifier of the language and locale of the bot recommendation to describe.

transcriptSourceSetting
  • Type: TranscriptSourceSetting structure

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeBotVersion

$result = $client->describeBotVersion([/* ... */]);
$promise = $client->describeBotVersionAsync([/* ... */]);

Provides metadata about a version of a bot.

Parameter Syntax

$result = $client->describeBotVersion([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot containing the version to return metadata for.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to return metadata for.

Result Syntax

[
    'botId' => '<string>',
    'botName' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'dataPrivacy' => [
        'childDirected' => true || false,
    ],
    'description' => '<string>',
    'failureReasons' => ['<string>', ...],
    'idleSessionTTLInSeconds' => <integer>,
    'roleArn' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the version.

botName
  • Type: string

The name of the bot that contains the version.

botStatus
  • Type: string

The current status of the bot. When the status is Available, the bot version is ready for use.

botVersion
  • Type: string

The version of the bot to describe.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot version was created.

dataPrivacy
  • Type: DataPrivacy structure

Data privacy settings for the bot version.

description
  • Type: string

The description specified for the bot.

failureReasons
  • Type: Array of strings

If the botStatus is Failed, this contains a list of reasons that the version couldn't be built.

idleSessionTTLInSeconds
  • Type: int

The number of seconds that a session with the bot remains active before it is discarded by Amazon Lex.

roleArn
  • Type: string

The Amazon Resource Name (ARN) of an IAM role that has permission to access the bot version.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeCustomVocabularyMetadata

$result = $client->describeCustomVocabularyMetadata([/* ... */]);
$promise = $client->describeCustomVocabularyMetadataAsync([/* ... */]);

Provides metadata information about a custom vocabulary.

Parameter Syntax

$result = $client->describeCustomVocabularyMetadata([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the custom vocabulary.

botVersion
  • Required: Yes
  • Type: string

The bot version of the bot to return metadata for.

localeId
  • Required: Yes
  • Type: string

The locale to return the custom vocabulary information for. The locale must be en_GB.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'customVocabularyStatus' => 'Ready|Deleting|Exporting|Importing|Creating',
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the custom vocabulary.

botVersion
  • Type: string

The version of the bot that contains the custom vocabulary to describe.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the custom vocabulary was created.

customVocabularyStatus
  • Type: string

The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the custom vocabulary was last updated.

localeId
  • Type: string

The locale that contains the custom vocabulary to describe.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeExport

$result = $client->describeExport([/* ... */]);
$promise = $client->describeExportAsync([/* ... */]);

Gets information about a specific export.

Parameter Syntax

$result = $client->describeExport([
    'exportId' => '<string>', // REQUIRED
]);

Parameter Details

Members
exportId
  • Required: Yes
  • Type: string

The unique identifier of the export to describe.

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'downloadUrl' => '<string>',
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
    'failureReasons' => ['<string>', ...],
    'fileFormat' => 'LexJson|TSV',
    'lastUpdatedDateTime' => <DateTime>,
    'resourceSpecification' => [
        'botExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the export was created.

downloadUrl
  • Type: string

A pre-signed S3 URL that points to the bot or bot locale archive. The URL is only available for 5 minutes after calling the DescribeExport operation.

exportId
  • Type: string

The unique identifier of the described export.

exportStatus
  • Type: string

The status of the export. When the status is Complete the export archive file is available for download.

failureReasons
  • Type: Array of strings

If the exportStatus is failed, contains one or more reasons why the export could not be completed.

fileFormat
  • Type: string

The file format used in the files that describe the resource.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that the export was updated.

resourceSpecification
  • Type: ExportResourceSpecification structure

The bot, bot ID, and optional locale ID of the exported bot or bot locale.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeImport

$result = $client->describeImport([/* ... */]);
$promise = $client->describeImportAsync([/* ... */]);

Gets information about a specific import.

Parameter Syntax

$result = $client->describeImport([
    'importId' => '<string>', // REQUIRED
]);

Parameter Details

Members
importId
  • Required: Yes
  • Type: string

The unique identifier of the import to describe.

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'failureReasons' => ['<string>', ...],
    'importId' => '<string>',
    'importStatus' => 'InProgress|Completed|Failed|Deleting',
    'importedResourceId' => '<string>',
    'importedResourceName' => '<string>',
    'lastUpdatedDateTime' => <DateTime>,
    'mergeStrategy' => 'Overwrite|FailOnConflict|Append',
    'resourceSpecification' => [
        'botImportSpecification' => [
            'botName' => '<string>',
            'botTags' => ['<string>', ...],
            'dataPrivacy' => [
                'childDirected' => true || false,
            ],
            'idleSessionTTLInSeconds' => <integer>,
            'roleArn' => '<string>',
            'testBotAliasTags' => ['<string>', ...],
        ],
        'botLocaleImportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
            'nluIntentConfidenceThreshold' => <float>,
            'voiceSettings' => [
                'engine' => 'standard|neural',
                'voiceId' => '<string>',
            ],
        ],
        'customVocabularyImportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the import was created.

failureReasons
  • Type: Array of strings

If the importStatus field is Failed, this provides one or more reasons for the failure.

importId
  • Type: string

The unique identifier of the described import.

importStatus
  • Type: string

The status of the import process. When the status is Completed the resource is imported and ready for use.

importedResourceId
  • Type: string

The unique identifier that Amazon Lex assigned to the resource created by the import.

importedResourceName
  • Type: string

The name of the imported resource.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the import was last updated.

mergeStrategy
  • Type: string

The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

resourceSpecification
  • Type: ImportResourceSpecification structure

The specifications of the imported bot, bot locale, or custom vocabulary.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeIntent

$result = $client->describeIntent([/* ... */]);
$promise = $client->describeIntentAsync([/* ... */]);

Returns metadata about an intent.

Parameter Syntax

$result = $client->describeIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the intent.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the intent.

intentId
  • Required: Yes
  • Type: string

The identifier of the intent to describe.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false,
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false,
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false,
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentId' => '<string>',
    'intentName' => '<string>',
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>',
        ],
        // ...
    ],
    'slotPriorities' => [
        [
            'priority' => <integer>,
            'slotId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the intent.

botVersion
  • Type: string

The version of the bot associated with the intent.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the intent was created.

description
  • Type: string

The description of the intent.

dialogCodeHook
  • Type: DialogCodeHookSettings structure

The Lambda function called during each turn of a conversation with the intent.

fulfillmentCodeHook
  • Type: FulfillmentCodeHookSettings structure

The Lambda function called when the intent is complete and ready for fulfillment.

inputContexts
  • Type: Array of InputContext structures

A list of contexts that must be active for the intent to be considered for sending to the user.

intentClosingSetting
  • Type: IntentClosingSetting structure

The response that Amazon Lex sends to when the intent is closed.

intentConfirmationSetting
  • Type: IntentConfirmationSetting structure

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

intentId
  • Type: string

The unique identifier assigned to the intent when it was created.

intentName
  • Type: string

The name specified for the intent.

kendraConfiguration
  • Type: KendraConfiguration structure

Configuration information required to use the AMAZON.KendraSearchIntent intent.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the intent was last updated.

localeId
  • Type: string

The language and locale specified for the intent.

outputContexts
  • Type: Array of OutputContext structures

A list of contexts that are activated when the intent is fulfilled.

parentIntentSignature
  • Type: string

The identifier of the built-in intent that this intent is derived from, if any.

sampleUtterances
  • Type: Array of SampleUtterance structures

User utterances that trigger this intent.

slotPriorities
  • Type: Array of SlotPriority structures

The list that determines the priority that slots should be elicited from the user.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

Gets the resource policy and policy revision for a bot or bot alias.

Parameter Syntax

$result = $client->describeResourcePolicy([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

Result Syntax

[
    'policy' => '<string>',
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
policy
  • Type: string

The JSON structure that contains the resource policy. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

DescribeSlot

$result = $client->describeSlot([/* ... */]);
$promise = $client->describeSlotAsync([/* ... */]);

Gets metadata information about a slot.

Parameter Syntax

$result = $client->describeSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'slotId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the slot.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the slot.

intentId
  • Required: Yes
  • Type: string

The identifier of the intent that contains the slot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

slotId
  • Required: Yes
  • Type: string

The unique identifier for the slot.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'intentId' => '<string>',
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation',
    ],
    'slotId' => '<string>',
    'slotName' => '<string>',
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [
        'defaultValueSpecification' => [
            'defaultValueList' => [
                [
                    'defaultValue' => '<string>',
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>',
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional',
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'waitingResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the slot.

botVersion
  • Type: string

The version of the bot associated with the slot.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot was created.

description
  • Type: string

The description specified for the slot.

intentId
  • Type: string

The identifier of the intent associated with the slot.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot was last updated.

localeId
  • Type: string

The language and locale specified for the slot.

multipleValuesSetting
  • Type: MultipleValuesSetting structure

Indicates whether the slot accepts multiple values in a single utterance.

If the multipleValuesSetting is not set, the default value is false.

obfuscationSetting
  • Type: ObfuscationSetting structure

Whether slot values are shown in Amazon CloudWatch logs. If the value is None, the actual value of the slot is shown in logs.

slotId
  • Type: string

The unique identifier generated for the slot.

slotName
  • Type: string

The name specified for the slot.

slotTypeId
  • Type: string

The identifier of the slot type that determines the values entered into the slot.

valueElicitationSetting
  • Type: SlotValueElicitationSetting structure

Prompts that Amazon Lex uses to elicit a value for the slot.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

DescribeSlotType

$result = $client->describeSlotType([/* ... */]);
$promise = $client->describeSlotTypeAsync([/* ... */]);

Gets metadata information about a slot type.

Parameter Syntax

$result = $client->describeSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'slotTypeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot associated with the slot type.

botVersion
  • Required: Yes
  • Type: string

The version of the bot associated with the slot type.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

slotTypeId
  • Required: Yes
  • Type: string

The identifier of the slot type.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
    ],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeId' => '<string>',
    'slotTypeName' => '<string>',
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>',
            ],
            'synonyms' => [
                [
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>',
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution',
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot associated with the slot type.

botVersion
  • Type: string

The version of the bot associated with the slot type.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot type was created.

description
  • Type: string

The description specified for the slot type.

externalSourceSetting
  • Type: ExternalSourceSetting structure

Provides information about the external source of the slot type's definition.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot type was last updated.

localeId
  • Type: string

The language and locale specified for the slot type.

parentSlotTypeSignature
  • Type: string

The built in slot type used as a parent to this slot type.

slotTypeId
  • Type: string

The unique identifier for the slot type.

slotTypeName
  • Type: string

The name specified for the slot type.

slotTypeValues
  • Type: Array of SlotTypeValue structures

The values that the slot type can take. Includes any synonyms for the slot type values.

valueSelectionSetting
  • Type: SlotValueSelectionSetting structure

The strategy that Amazon Lex uses to choose a value from a list of possible values.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListAggregatedUtterances

$result = $client->listAggregatedUtterances([/* ... */]);
$promise = $client->listAggregatedUtterancesAsync([/* ... */]);

Provides a list of utterances that users have sent to the bot.

Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase "I want to order pizza" are aggregated into the same line in the response.

You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.

Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.

Utterances statistics are not generated under the following conditions:

  • The childDirected field was set to true when the bot was created.

  • You are using slot obfuscation with one or more slots.

  • You opted out of participating in improving Amazon Lex.

Parameter Syntax

$result = $client->listAggregatedUtterances([
    'aggregationDuration' => [ // REQUIRED
        'relativeAggregationDuration' => [ // REQUIRED
            'timeDimension' => 'Hours|Days|Weeks', // REQUIRED
            'timeValue' => <integer>, // REQUIRED
        ],
    ],
    'botAliasId' => '<string>',
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>',
    'filters' => [
        [
            'name' => 'Utterance', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'HitCount|MissedCount', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
aggregationDuration
  • Required: Yes
  • Type: UtteranceAggregationDuration structure

The time window for aggregating the utterance information. You can specify a time between one hour and two weeks.

botAliasId
  • Type: string

The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.

botId
  • Required: Yes
  • Type: string

The unique identifier of the bot associated with this request.

botVersion
  • Type: string

The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.

filters
  • Type: Array of AggregatedUtterancesFilter structures

Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale where the utterances were collected. For more information, see Supported languages.

maxResults
  • Type: int

The maximum number of utterances 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. If you don't specify the maxResults parameter, 1,000 results are returned.

nextToken
  • Type: string

If the response from the ListAggregatedUtterances operation contains more results that 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.

sortBy
  • Type: AggregatedUtterancesSortBy structure

Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.

Result Syntax

[
    'aggregatedUtterancesSummaries' => [
        [
            'containsDataFromDeletedResources' => true || false,
            'hitCount' => <integer>,
            'missedCount' => <integer>,
            'utterance' => '<string>',
            'utteranceFirstRecordedInAggregationDuration' => <DateTime>,
            'utteranceLastRecordedInAggregationDuration' => <DateTime>,
        ],
        // ...
    ],
    'aggregationDuration' => [
        'relativeAggregationDuration' => [
            'timeDimension' => 'Hours|Days|Weeks',
            'timeValue' => <integer>,
        ],
    ],
    'aggregationLastRefreshedDateTime' => <DateTime>,
    'aggregationWindowEndTime' => <DateTime>,
    'aggregationWindowStartTime' => <DateTime>,
    'botAliasId' => '<string>',
    'botId' => '<string>',
    'botVersion' => '<string>',
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
aggregatedUtterancesSummaries
  • Type: Array of AggregatedUtterancesSummary structures

Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.

aggregationDuration
  • Type: UtteranceAggregationDuration structure

The time period used to aggregate the utterance data.

aggregationLastRefreshedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that the aggregated data was collected. The time period depends on the length of the aggregation window.

  • Hours - for 1 hour time window, every half hour; otherwise every hour.

  • Days - every 6 hours

  • Weeks - for a one week time window, every 12 hours; otherwise, every day

aggregationWindowEndTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the aggregation window ends. Only data collected between the start time and the end time are returned in the results.

aggregationWindowStartTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the aggregation window begins. Only data collected after this time is returned in the results.

botAliasId
  • Type: string

The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.

botId
  • Type: string

The identifier of the bot that contains the utterances.

botVersion
  • Type: string

The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.

localeId
  • Type: string

The identifier of the language and locale that the utterances are in.

nextToken
  • Type: string

A token that indicates whether there are more results to return in a response to the ListAggregatedUtterances operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListAggregatedUtterances operation request to get the next page of results.

Errors

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBotAliases

$result = $client->listBotAliases([/* ... */]);
$promise = $client->listBotAliasesAsync([/* ... */]);

Gets a list of aliases for the specified bot.

Parameter Syntax

$result = $client->listBotAliases([
    'botId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to list aliases for.

maxResults
  • Type: int

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
  • Type: string

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.

Result Syntax

[
    'botAliasSummaries' => [
        [
            'botAliasId' => '<string>',
            'botAliasName' => '<string>',
            'botAliasStatus' => 'Creating|Available|Deleting|Failed',
            'botVersion' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
        ],
        // ...
    ],
    'botId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botAliasSummaries
  • Type: Array of BotAliasSummary structures

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.

botId
  • Type: string

The identifier of the bot associated with the aliases.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBotLocales

$result = $client->listBotLocales([/* ... */]);
$promise = $client->listBotLocalesAsync([/* ... */]);

Gets a list of locales for the specified bot.

Parameter Syntax

$result = $client->listBotLocales([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'filters' => [
        [
            'name' => 'BotLocaleName', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'BotLocaleName', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to list locales for.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to list locales for.

filters
  • Type: Array of BotLocaleFilter structures

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
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: BotLocaleSortBy structure

Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleSummaries' => [
        [
            'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
            'description' => '<string>',
            'lastBuildSubmittedDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
            'localeId' => '<string>',
            'localeName' => '<string>',
        ],
        // ...
    ],
    'botVersion' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot to list locales for.

botLocaleSummaries
  • Type: Array of BotLocaleSummary structures

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.

botVersion
  • Type: string

The version of the bot.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBotRecommendations

$result = $client->listBotRecommendations([/* ... */]);
$promise = $client->listBotRecommendationsAsync([/* ... */]);

Get a list of bot recommendations that meet the specified criteria.

Parameter Syntax

$result = $client->listBotRecommendations([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the bot recommendation list.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the bot recommendation list.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the bot recommendation list.

maxResults
  • Type: int

The maximum number of bot recommendations 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
  • Type: string

If the response from the ListBotRecommendation 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.

Result Syntax

[
    'botId' => '<string>',
    'botRecommendationSummaries' => [
        [
            'botRecommendationId' => '<string>',
            'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed',
            'creationDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
        ],
        // ...
    ],
    'botVersion' => '<string>',
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot that contains the bot recommendation list.

botRecommendationSummaries
  • Type: Array of BotRecommendationSummary structures

Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.

botVersion
  • Type: string

The version of the bot that contains the bot recommendation list.

localeId
  • Type: string

The identifier of the language and locale of the bot recommendation list.

nextToken
  • Type: string

A token that indicates whether there are more results to return in a response to the ListBotRecommendations operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotRecommendations operation request to get the next page of results.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

ListBotVersions

$result = $client->listBotVersions([/* ... */]);
$promise = $client->listBotVersionsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listBotVersions([
    'botId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'BotVersion', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to list versions for.

maxResults
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: BotVersionSortBy structure

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.

Result Syntax

[
    'botId' => '<string>',
    'botVersionSummaries' => [
        [
            'botName' => '<string>',
            'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
            'botVersion' => '<string>',
            'creationDateTime' => <DateTime>,
            'description' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot to list versions for.

botVersionSummaries
  • Type: Array of BotVersionSummary structures

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.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBots

$result = $client->listBots([/* ... */]);
$promise = $client->listBotsAsync([/* ... */]);

Gets a list of available bots.

Parameter Syntax

$result = $client->listBots([
    'filters' => [
        [
            'name' => 'BotName', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'BotName', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
filters
  • Type: Array of BotFilter structures

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
  • Type: int

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
  • Type: string

If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

sortBy
  • Type: BotSortBy structure

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

Result Syntax

[
    'botSummaries' => [
        [
            'botId' => '<string>',
            'botName' => '<string>',
            'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
            'description' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'latestBotVersion' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
botSummaries
  • Type: Array of BotSummary structures

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.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBuiltInIntents

$result = $client->listBuiltInIntents([/* ... */]);
$promise = $client->listBuiltInIntentsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listBuiltInIntents([
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'IntentSignature', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
localeId
  • Required: Yes
  • Type: string

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 Supported languages.

maxResults
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: BuiltInIntentSortBy structure

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.

Result Syntax

[
    'builtInIntentSummaries' => [
        [
            'description' => '<string>',
            'intentSignature' => '<string>',
        ],
        // ...
    ],
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
builtInIntentSummaries
  • Type: Array of BuiltInIntentSummary structures

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.

localeId
  • Type: string

The language and locale of the intents in the list.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListBuiltInSlotTypes

$result = $client->listBuiltInSlotTypes([/* ... */]);
$promise = $client->listBuiltInSlotTypesAsync([/* ... */]);

Gets a list of built-in slot types that meet the specified criteria.

Parameter Syntax

$result = $client->listBuiltInSlotTypes([
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'SlotTypeSignature', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
localeId
  • Required: Yes
  • Type: string

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 Supported languages.

maxResults
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: BuiltInSlotTypeSortBy structure

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.

Result Syntax

[
    'builtInSlotTypeSummaries' => [
        [
            'description' => '<string>',
            'slotTypeSignature' => '<string>',
        ],
        // ...
    ],
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
builtInSlotTypeSummaries
  • Type: Array of BuiltInSlotTypeSummary structures

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.

localeId
  • Type: string

The language and locale of the slot types in the list.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListExports

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.

Parameter Syntax

$result = $client->listExports([
    'botId' => '<string>',
    'botVersion' => '<string>',
    'filters' => [
        [
            'name' => 'ExportResourceType', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'LastUpdatedDateTime', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Type: string

The unique identifier that Amazon Lex assigned to the bot.

botVersion
  • Type: string

The version of the bot to list exports for.

filters
  • Type: Array of ExportFilter structures

Provides the specification of a filter used to limit the exports in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

localeId
  • Type: string

Specifies the resources that should be exported. If you don't specify a resource type in the filters parameter, both bot locales and custom vocabularies are exported.

maxResults
  • Type: int

The maximum number of exports 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
  • Type: string

If the response from the ListExports operation contains more results that specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListExports request to return the next page of results. For a complete set of results, call the ListExports operation until the nextToken returned in the response is null.

sortBy
  • Type: ExportSortBy structure

Determines the field that the list of exports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'exportSummaries' => [
        [
            'creationDateTime' => <DateTime>,
            'exportId' => '<string>',
            'exportStatus' => 'InProgress|Completed|Failed|Deleting',
            'fileFormat' => 'LexJson|TSV',
            'lastUpdatedDateTime' => <DateTime>,
            'resourceSpecification' => [
                'botExportSpecification' => [
                    'botId' => '<string>',
                    'botVersion' => '<string>',
                ],
                'botLocaleExportSpecification' => [
                    'botId' => '<string>',
                    'botVersion' => '<string>',
                    'localeId' => '<string>',
                ],
                'customVocabularyExportSpecification' => [
                    'botId' => '<string>',
                    'botVersion' => '<string>',
                    'localeId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The unique identifier assigned to the bot by Amazon Lex.

botVersion
  • Type: string

The version of the bot that was exported.

exportSummaries
  • Type: Array of ExportSummary structures

Summary information for the exports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more exports available, the nextToken field contains a token to get the next page of results.

localeId
  • Type: string

The locale specified in the request.

nextToken
  • Type: string

A token that indicates whether there are more results to return in a response to the ListExports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListExports operation request to get the next page of results.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListImports

$result = $client->listImports([/* ... */]);
$promise = $client->listImportsAsync([/* ... */]);

Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.

Parameter Syntax

$result = $client->listImports([
    'botId' => '<string>',
    'botVersion' => '<string>',
    'filters' => [
        [
            'name' => 'ImportResourceType', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'LastUpdatedDateTime', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Type: string

The unique identifier that Amazon Lex assigned to the bot.

botVersion
  • Type: string

The version of the bot to list imports for.

filters
  • Type: Array of ImportFilter structures

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.

localeId
  • Type: string

Specifies the locale that should be present in the list. If you don't specify a resource type in the filters parameter, the list contains both bot locales and custom vocabularies.

maxResults
  • Type: int

The maximum number of imports 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
  • Type: string

If the response from the ListImports operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListImports request to return the next page of results. For a complete set of results, call the ListImports operation until the nextToken returned in the response is null.

sortBy
  • Type: ImportSortBy structure

Determines the field that the list of imports is sorted by. You can sort by the LastUpdatedDateTime field in ascending or descending order.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'importSummaries' => [
        [
            'creationDateTime' => <DateTime>,
            'importId' => '<string>',
            'importStatus' => 'InProgress|Completed|Failed|Deleting',
            'importedResourceId' => '<string>',
            'importedResourceName' => '<string>',
            'importedResourceType' => 'Bot|BotLocale|CustomVocabulary',
            'lastUpdatedDateTime' => <DateTime>,
            'mergeStrategy' => 'Overwrite|FailOnConflict|Append',
        ],
        // ...
    ],
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The unique identifier assigned by Amazon Lex to the bot.

botVersion
  • Type: string

The version of the bot that was imported. It will always be DRAFT.

importSummaries
  • Type: Array of ImportSummary structures

Summary information for the imports that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter. If there are more imports available, the nextToken field contains a token to get the next page of results.

localeId
  • Type: string

The locale specified in the request.

nextToken
  • Type: string

A token that indicates whether there are more results to return in a response to the ListImports operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListImports operation request to get the next page of results.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListIntents

$result = $client->listIntents([/* ... */]);
$promise = $client->listIntentsAsync([/* ... */]);

Get a list of intents that meet the specified criteria.

Parameter Syntax

$result = $client->listIntents([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'filters' => [
        [
            'name' => 'IntentName', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'IntentName|LastUpdatedDateTime', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the intent.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the intent.

filters
  • Type: Array of IntentFilter structures

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.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

maxResults
  • Type: int

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
  • Type: string

If the response from the ListIntents operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListIntents request to return the next page of results. For a complete set of results, call the ListIntents operation until the nextToken returned in the response is null.

sortBy
  • Type: IntentSortBy structure

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.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'intentSummaries' => [
        [
            'description' => '<string>',
            'inputContexts' => [
                [
                    'name' => '<string>',
                ],
                // ...
            ],
            'intentId' => '<string>',
            'intentName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'outputContexts' => [
                [
                    'name' => '<string>',
                    'timeToLiveInSeconds' => <integer>,
                    'turnsToLive' => <integer>,
                ],
                // ...
            ],
            'parentIntentSignature' => '<string>',
        ],
        // ...
    ],
    'localeId' => '<string>',
    'nextToken' => '<string>',
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the intent.

botVersion
  • Type: string

The version of the bot that contains the intent.

intentSummaries
  • Type: Array of IntentSummary structures

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.

localeId
  • Type: string

The language and locale of the intents in the list.

nextToken
  • Type: string

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListRecommendedIntents

$result = $client->listRecommendedIntents([/* ... */]);
$promise = $client->listRecommendedIntentsAsync([/* ... */]);

Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.

Parameter Syntax

$result = $client->listRecommendedIntents([
    'botId' => '<string>', // REQUIRED
    'botRecommendationId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot associated with the recommended intents.

botRecommendationId
  • Required: Yes
  • Type: string

The identifier of the bot recommendation that contains the recommended intents.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the recommended intents.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the recommended intents.

maxResults
  • Type: int

The maximum number of bot recommendations 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
  • Type: string

If the response from the ListRecommendedIntents 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.

Result Syntax

[
    'botId' => '<string>',
    'botRecommendationId' => '<string>',
    'botVersion' => '<string>',
    'localeId' => '<string>',
    'nextToken' => '<string>',
    'summaryList' => [
        [
            'intentId' => '<string>',
            'intentName' => '<string>',
            'sampleUtterancesCount' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot associated with the recommended intent.

botRecommendationId
  • Type: string

The identifier of the bot recommendation that contains the recommended intent.

botVersion
  • Type: string

The version of the bot that contains the intent.

localeId
  • Type: string

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 Supported languages.

nextToken
  • Type: string

A token that indicates whether there are more results to return in a response to the ListRecommendedIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListRecommendedIntents operation request to get the next page of results.

summaryList
  • Type: Array of RecommendedIntentSummary structures

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

ListSlotTypes

$result = $client->listSlotTypes([/* ... */]);
$promise = $client->listSlotTypesAsync([/* ... */]);

Gets a list of slot types that match the specified criteria.

Parameter Syntax

$result = $client->listSlotTypes([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'filters' => [
        [
            'name' => 'SlotTypeName|ExternalSourceType', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'SlotTypeName|LastUpdatedDateTime', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the slot types.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the slot type.

filters
  • Type: Array of SlotTypeFilter structures

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.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

maxResults
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: SlotTypeSortBy structure

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.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'localeId' => '<string>',
    'nextToken' => '<string>',
    'slotTypeSummaries' => [
        [
            'description' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'parentSlotTypeSignature' => '<string>',
            'slotTypeCategory' => 'Custom|Extended|ExternalGrammar',
            'slotTypeId' => '<string>',
            'slotTypeName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the slot types.

botVersion
  • Type: string

The version of the bot that contains the slot types.

localeId
  • Type: string

The language and local of the slot types in the list.

nextToken
  • Type: string

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.

slotTypeSummaries
  • Type: Array of SlotTypeSummary structures

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListSlots

$result = $client->listSlots([/* ... */]);
$promise = $client->listSlotsAsync([/* ... */]);

Gets a list of slots that match the specified criteria.

Parameter Syntax

$result = $client->listSlots([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'filters' => [
        [
            'name' => 'SlotName', // REQUIRED
            'operator' => 'CO|EQ', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'attribute' => 'SlotName|LastUpdatedDateTime', // REQUIRED
        'order' => 'Ascending|Descending', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot that contains the slot.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the slot.

filters
  • Type: Array of SlotFilter structures

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.

intentId
  • Required: Yes
  • Type: string

The unique identifier of the intent that contains the slot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

maxResults
  • Type: int

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
  • Type: string

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.

sortBy
  • Type: SlotSortBy structure

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.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'intentId' => '<string>',
    'localeId' => '<string>',
    'nextToken' => '<string>',
    'slotSummaries' => [
        [
            'description' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'slotConstraint' => 'Required|Optional',
            'slotId' => '<string>',
            'slotName' => '<string>',
            'slotTypeId' => '<string>',
            'valueElicitationPromptSpecification' => [
                'allowInterrupt' => true || false,
                'maxRetries' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the slots.

botVersion
  • Type: string

The version of the bot that contains the slots.

intentId
  • Type: string

The identifier of the intent that contains the slots.

localeId
  • Type: string

The language and locale of the slots in the list.

nextToken
  • Type: string

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.

slotSummaries
  • Type: Array of SlotSummary structures

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.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource to get a list of tags for.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
  • Type: Associative array of custom strings keys (TagKey) to strings

The tags associated with a resource.

Errors

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

SearchAssociatedTranscripts

$result = $client->searchAssociatedTranscripts([/* ... */]);
$promise = $client->searchAssociatedTranscriptsAsync([/* ... */]);

Search for associated transcripts that meet the specified criteria.

Parameter Syntax

$result = $client->searchAssociatedTranscripts([
    'botId' => '<string>', // REQUIRED
    'botRecommendationId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'filters' => [ // REQUIRED
        [
            'name' => 'IntentId|SlotTypeId', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'localeId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextIndex' => <integer>,
    'searchOrder' => 'Ascending|Descending',
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot associated with the transcripts that you are searching.

botRecommendationId
  • Required: Yes
  • Type: string

The unique identifier of the bot recommendation associated with the transcripts to search.

botVersion
  • Required: Yes
  • Type: string

The version of the bot containing the transcripts that you are searching.

filters
  • Required: Yes
  • Type: Array of AssociatedTranscriptFilter structures

A list of filter objects.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

maxResults
  • Type: int

The maximum number of bot recommendations 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.

nextIndex
  • Type: int

If the response from the SearchAssociatedTranscriptsRequest operation contains more results than specified in the maxResults parameter, an index is returned in the response. Use that index in the nextIndex parameter to return the next page of results.

searchOrder
  • Type: string

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

Result Syntax

[
    'associatedTranscripts' => [
        [
            'transcript' => '<string>',
        ],
        // ...
    ],
    'botId' => '<string>',
    'botRecommendationId' => '<string>',
    'botVersion' => '<string>',
    'localeId' => '<string>',
    'nextIndex' => <integer>,
    'totalResults' => <integer>,
]

Result Details

Members
associatedTranscripts
  • Type: Array of AssociatedTranscript structures

The object that contains the associated transcript that meet the criteria you specified.

botId
  • Type: string

The unique identifier of the bot associated with the transcripts that you are searching.

botRecommendationId
  • Type: string

The unique identifier of the bot recommendation associated with the transcripts to search.

botVersion
  • Type: string

The version of the bot containing the transcripts that you are searching.

localeId
  • Type: string

The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

nextIndex
  • Type: int

A index that indicates whether there are more results to return in a response to the SearchAssociatedTranscripts operation. If the nextIndex field is present, you send the contents as the nextIndex parameter of a SearchAssociatedTranscriptsRequest operation to get the next page of results.

totalResults
  • Type: int

The total number of transcripts returned by the search.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

StartBotRecommendation

$result = $client->startBotRecommendation([/* ... */]);
$promise = $client->startBotRecommendationAsync([/* ... */]);

Use this to provide your transcript data, and to start the bot recommendation process.

Parameter Syntax

$result = $client->startBotRecommendation([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'encryptionSetting' => [
        'associatedTranscriptsPassword' => '<string>',
        'botLocaleExportPassword' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'localeId' => '<string>', // REQUIRED
    'transcriptSourceSetting' => [ // REQUIRED
        's3BucketTranscriptSource' => [
            'kmsKeyArn' => '<string>',
            'pathFormat' => [
                'objectPrefixes' => ['<string>', ...],
            ],
            's3BucketName' => '<string>', // REQUIRED
            'transcriptFilter' => [
                'lexTranscriptFilter' => [
                    'dateRangeFilter' => [
                        'endDateTime' => <integer || string || DateTime>, // REQUIRED
                        'startDateTime' => <integer || string || DateTime>, // REQUIRED
                    ],
                ],
            ],
            'transcriptFormat' => 'Lex', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot containing the bot recommendation.

botVersion
  • Required: Yes
  • Type: string

The version of the bot containing the bot recommendation.

encryptionSetting
  • Type: EncryptionSetting structure

The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

transcriptSourceSetting
  • Required: Yes
  • Type: TranscriptSourceSetting structure

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Result Syntax

[
    'botId' => '<string>',
    'botRecommendationId' => '<string>',
    'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'encryptionSetting' => [
        'associatedTranscriptsPassword' => '<string>',
        'botLocaleExportPassword' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'localeId' => '<string>',
    'transcriptSourceSetting' => [
        's3BucketTranscriptSource' => [
            'kmsKeyArn' => '<string>',
            'pathFormat' => [
                'objectPrefixes' => ['<string>', ...],
            ],
            's3BucketName' => '<string>',
            'transcriptFilter' => [
                'lexTranscriptFilter' => [
                    'dateRangeFilter' => [
                        'endDateTime' => <DateTime>,
                        'startDateTime' => <DateTime>,
                    ],
                ],
            ],
            'transcriptFormat' => 'Lex',
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot containing the bot recommendation.

botRecommendationId
  • Type: string

The identifier of the bot recommendation that you have created.

botRecommendationStatus
  • Type: string

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

botVersion
  • Type: string

The version of the bot containing the bot recommendation.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot recommendation was created.

encryptionSetting
  • Type: EncryptionSetting structure

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

localeId
  • Type: string

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

transcriptSourceSetting
  • Type: TranscriptSourceSetting structure

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

StartImport

$result = $client->startImport([/* ... */]);
$promise = $client->startImportAsync([/* ... */]);

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

Parameter Syntax

$result = $client->startImport([
    'filePassword' => '<string>',
    'importId' => '<string>', // REQUIRED
    'mergeStrategy' => 'Overwrite|FailOnConflict|Append', // REQUIRED
    'resourceSpecification' => [ // REQUIRED
        'botImportSpecification' => [
            'botName' => '<string>', // REQUIRED
            'botTags' => ['<string>', ...],
            'dataPrivacy' => [ // REQUIRED
                'childDirected' => true || false, // REQUIRED
            ],
            'idleSessionTTLInSeconds' => <integer>,
            'roleArn' => '<string>', // REQUIRED
            'testBotAliasTags' => ['<string>', ...],
        ],
        'botLocaleImportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
            'nluIntentConfidenceThreshold' => <float>,
            'voiceSettings' => [
                'engine' => 'standard|neural',
                'voiceId' => '<string>', // REQUIRED
            ],
        ],
        'customVocabularyImportSpecification' => [
            'botId' => '<string>', // REQUIRED
            'botVersion' => '<string>', // REQUIRED
            'localeId' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
filePassword
  • Type: string

The password used to encrypt the zip archive that contains the resource definition. You should always encrypt the zip archive to protect it during transit between your site and Amazon Lex.

importId
  • Required: Yes
  • Type: string

The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

mergeStrategy
  • Required: Yes
  • Type: string

The strategy to use when there is a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

resourceSpecification
  • Required: Yes
  • Type: ImportResourceSpecification structure

Parameters for creating the bot, bot locale or custom vocabulary.

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'importId' => '<string>',
    'importStatus' => 'InProgress|Completed|Failed|Deleting',
    'mergeStrategy' => 'Overwrite|FailOnConflict|Append',
    'resourceSpecification' => [
        'botImportSpecification' => [
            'botName' => '<string>',
            'botTags' => ['<string>', ...],
            'dataPrivacy' => [
                'childDirected' => true || false,
            ],
            'idleSessionTTLInSeconds' => <integer>,
            'roleArn' => '<string>',
            'testBotAliasTags' => ['<string>', ...],
        ],
        'botLocaleImportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
            'nluIntentConfidenceThreshold' => <float>,
            'voiceSettings' => [
                'engine' => 'standard|neural',
                'voiceId' => '<string>',
            ],
        ],
        'customVocabularyImportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the import request was created.

importId
  • Type: string

A unique identifier for the import.

importStatus
  • Type: string

The current status of the import. When the status is Complete the bot, bot alias, or custom vocabulary is ready to use.

mergeStrategy
  • Type: string

The strategy used when there was a name conflict between the imported resource and an existing resource. When the merge strategy is FailOnConflict existing resources are not overwritten and the import fails.

resourceSpecification
  • Type: ImportResourceSpecification structure

The parameters used when importing the resource.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

Parameter Syntax

$result = $client->tagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.

tags
  • Required: Yes
  • Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a bot, bot alias, or bot channel.

Parameter Syntax

$result = $client->untagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceARN
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource to remove the tags from.

tagKeys
  • Required: Yes
  • Type: Array of strings

A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

UpdateBot

$result = $client->updateBot([/* ... */]);
$promise = $client->updateBotAsync([/* ... */]);

Updates the configuration of an existing bot.

Parameter Syntax

$result = $client->updateBot([
    'botId' => '<string>', // REQUIRED
    'botName' => '<string>', // REQUIRED
    'dataPrivacy' => [ // REQUIRED
        'childDirected' => true || false, // REQUIRED
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>, // REQUIRED
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

botName
  • Required: Yes
  • Type: string

The new name of the bot. The name must be unique in the account that creates the bot.

dataPrivacy
  • Required: Yes
  • Type: DataPrivacy structure

Provides information on additional privacy protections Amazon Lex should use with the bot's data.

description
  • Type: string

A description of the bot.

idleSessionTTLInSeconds
  • Required: Yes
  • Type: int

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.

roleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the bot.

Result Syntax

[
    'botId' => '<string>',
    'botName' => '<string>',
    'botStatus' => 'Creating|Available|Inactive|Deleting|Failed|Versioning|Importing',
    'creationDateTime' => <DateTime>,
    'dataPrivacy' => [
        'childDirected' => true || false,
    ],
    'description' => '<string>',
    'idleSessionTTLInSeconds' => <integer>,
    'lastUpdatedDateTime' => <DateTime>,
    'roleArn' => '<string>',
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot that was updated.

botName
  • Type: string

The name of the bot after the update.

botStatus
  • Type: string

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.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was created.

dataPrivacy
  • Type: DataPrivacy structure

The data privacy settings for the bot after the update.

description
  • Type: string

The description of the bot after the update.

idleSessionTTLInSeconds
  • Type: int

The session timeout, in seconds, for the bot after the update.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was last updated.

roleArn
  • Type: string

The Amazon Resource Name (ARN) of the IAM role used by the bot after the update.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateBotAlias

$result = $client->updateBotAlias([/* ... */]);
$promise = $client->updateBotAliasAsync([/* ... */]);

Updates the configuration of an existing bot alias.

Parameter Syntax

$result = $client->updateBotAlias([
    'botAliasId' => '<string>', // REQUIRED
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [ // REQUIRED
                    'codeHookInterfaceVersion' => '<string>', // REQUIRED
                    'lambdaARN' => '<string>', // REQUIRED
                ],
            ],
            'enabled' => true || false, // REQUIRED
        ],
        // ...
    ],
    'botAliasName' => '<string>', // REQUIRED
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    's3Bucket' => [ // REQUIRED
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>', // REQUIRED
                        's3BucketArn' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [ // REQUIRED
                    'cloudWatch' => [ // REQUIRED
                        'cloudWatchLogGroupArn' => '<string>', // REQUIRED
                        'logPrefix' => '<string>', // REQUIRED
                    ],
                ],
                'enabled' => true || false, // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false, // REQUIRED
    ],
]);

Parameter Details

Members
botAliasId
  • Required: Yes
  • Type: string

The unique identifier of the bot alias.

botAliasLocaleSettings
  • Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures

The new Lambda functions to use in each locale for the bot alias.

botAliasName
  • Required: Yes
  • Type: string

The new name to assign to the bot alias.

botId
  • Required: Yes
  • Type: string

The identifier of the bot with the updated alias.

botVersion
  • Type: string

The new bot version to assign to the bot alias.

conversationLogSettings
  • Type: ConversationLogSettings structure

The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

description
  • Type: string

The new description to assign to the bot alias.

sentimentAnalysisSettings
  • Type: SentimentAnalysisSettings structure

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Result Syntax

[
    'botAliasId' => '<string>',
    'botAliasLocaleSettings' => [
        '<LocaleId>' => [
            'codeHookSpecification' => [
                'lambdaCodeHook' => [
                    'codeHookInterfaceVersion' => '<string>',
                    'lambdaARN' => '<string>',
                ],
            ],
            'enabled' => true || false,
        ],
        // ...
    ],
    'botAliasName' => '<string>',
    'botAliasStatus' => 'Creating|Available|Deleting|Failed',
    'botId' => '<string>',
    'botVersion' => '<string>',
    'conversationLogSettings' => [
        'audioLogSettings' => [
            [
                'destination' => [
                    's3Bucket' => [
                        'kmsKeyArn' => '<string>',
                        'logPrefix' => '<string>',
                        's3BucketArn' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
        'textLogSettings' => [
            [
                'destination' => [
                    'cloudWatch' => [
                        'cloudWatchLogGroupArn' => '<string>',
                        'logPrefix' => '<string>',
                    ],
                ],
                'enabled' => true || false,
            ],
            // ...
        ],
    ],
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'lastUpdatedDateTime' => <DateTime>,
    'sentimentAnalysisSettings' => [
        'detectSentiment' => true || false,
    ],
]

Result Details

Members
botAliasId
  • Type: string

The identifier of the updated bot alias.

botAliasLocaleSettings
  • Type: Associative array of custom strings keys (LocaleId) to BotAliasLocaleSettings structures

The updated Lambda functions to use in each locale for the bot alias.

botAliasName
  • Type: string

The updated name of the bot alias.

botAliasStatus
  • Type: string

The current status of the bot alias. When the status is Available the alias is ready for use.

botId
  • Type: string

The identifier of the bot with the updated alias.

botVersion
  • Type: string

The updated version of the bot that the alias points to.

conversationLogSettings
  • Type: ConversationLogSettings structure

The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was created.

description
  • Type: string

The updated description of the bot alias.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot was last updated.

sentimentAnalysisSettings
  • Type: SentimentAnalysisSettings structure

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateBotLocale

$result = $client->updateBotLocale([/* ... */]);
$promise = $client->updateBotLocaleAsync([/* ... */]);

Updates the settings that a bot has for a specific locale.

Parameter Syntax

$result = $client->updateBotLocale([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'localeId' => '<string>', // REQUIRED
    'nluIntentConfidenceThreshold' => <float>, // REQUIRED
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the locale.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

description
  • Type: string

The new description of the locale.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

nluIntentConfidenceThreshold
  • Required: Yes
  • Type: double

The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

voiceSettings
  • Type: VoiceSettings structure

The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

Result Syntax

[
    'botId' => '<string>',
    'botLocaleStatus' => 'Creating|Building|Built|ReadyExpressTesting|Failed|Deleting|NotBuilt|Importing|Processing',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'failureReasons' => ['<string>', ...],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'localeName' => '<string>',
    'nluIntentConfidenceThreshold' => <float>,
    'recommendedActions' => ['<string>', ...],
    'voiceSettings' => [
        'engine' => 'standard|neural',
        'voiceId' => '<string>',
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the updated locale.

botLocaleStatus
  • Type: string

The current status of the locale. When the bot status is Built the locale is ready for use.

botVersion
  • Type: string

The version of the bot that contains the updated locale.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the locale was created.

description
  • Type: string

The updated description of the locale.

failureReasons
  • Type: Array of strings

If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the locale was last updated.

localeId
  • Type: string

The language and locale of the updated bot locale.

localeName
  • Type: string

The updated locale name for the locale.

nluIntentConfidenceThreshold
  • Type: double

The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

recommendedActions
  • Type: Array of strings

Recommended actions to take to resolve an error in the failureReasons field.

voiceSettings
  • Type: VoiceSettings structure

The updated Amazon Polly voice to use for voice interaction with the user.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateBotRecommendation

$result = $client->updateBotRecommendation([/* ... */]);
$promise = $client->updateBotRecommendationAsync([/* ... */]);

Updates an existing bot recommendation request.

Parameter Syntax

$result = $client->updateBotRecommendation([
    'botId' => '<string>', // REQUIRED
    'botRecommendationId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'encryptionSetting' => [ // REQUIRED
        'associatedTranscriptsPassword' => '<string>',
        'botLocaleExportPassword' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'localeId' => '<string>', // REQUIRED
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot containing the bot recommendation to be updated.

botRecommendationId
  • Required: Yes
  • Type: string

The unique identifier of the bot recommendation to be updated.

botVersion
  • Required: Yes
  • Type: string

The version of the bot containing the bot recommendation to be updated.

encryptionSetting
  • Required: Yes
  • Type: EncryptionSetting structure

The object representing the passwords that will be used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages

Result Syntax

[
    'botId' => '<string>',
    'botRecommendationId' => '<string>',
    'botRecommendationStatus' => 'Processing|Deleting|Deleted|Downloading|Updating|Available|Failed',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'encryptionSetting' => [
        'associatedTranscriptsPassword' => '<string>',
        'botLocaleExportPassword' => '<string>',
        'kmsKeyArn' => '<string>',
    ],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'transcriptSourceSetting' => [
        's3BucketTranscriptSource' => [
            'kmsKeyArn' => '<string>',
            'pathFormat' => [
                'objectPrefixes' => ['<string>', ...],
            ],
            's3BucketName' => '<string>',
            'transcriptFilter' => [
                'lexTranscriptFilter' => [
                    'dateRangeFilter' => [
                        'endDateTime' => <DateTime>,
                        'startDateTime' => <DateTime>,
                    ],
                ],
            ],
            'transcriptFormat' => 'Lex',
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The unique identifier of the bot containing the bot recommendation that has been updated.

botRecommendationId
  • Type: string

The unique identifier of the bot recommendation to be updated.

botRecommendationStatus
  • Type: string

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

botVersion
  • Type: string

The version of the bot containing the bot recommendation that has been updated.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot recommendation was created.

encryptionSetting
  • Type: EncryptionSetting structure

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot recommendation was last updated.

localeId
  • Type: string

The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages

transcriptSourceSetting
  • Type: TranscriptSourceSetting structure

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateExport

$result = $client->updateExport([/* ... */]);
$promise = $client->updateExportAsync([/* ... */]);

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

Parameter Syntax

$result = $client->updateExport([
    'exportId' => '<string>', // REQUIRED
    'filePassword' => '<string>',
]);

Parameter Details

Members
exportId
  • Required: Yes
  • Type: string

The unique identifier Amazon Lex assigned to the export.

filePassword
  • Type: string

The new password to use to encrypt the export zip archive.

Result Syntax

[
    'creationDateTime' => <DateTime>,
    'exportId' => '<string>',
    'exportStatus' => 'InProgress|Completed|Failed|Deleting',
    'fileFormat' => 'LexJson|TSV',
    'lastUpdatedDateTime' => <DateTime>,
    'resourceSpecification' => [
        'botExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
        ],
        'botLocaleExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
        'customVocabularyExportSpecification' => [
            'botId' => '<string>',
            'botVersion' => '<string>',
            'localeId' => '<string>',
        ],
    ],
]

Result Details

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the export was created.

exportId
  • Type: string

The unique identifier Amazon Lex assigned to the export.

exportStatus
  • Type: string

The status of the export. When the status is Completed the export archive is available for download.

fileFormat
  • Type: string

The file format used for the files that define the resource. The TSV format is required to export a custom vocabulary only; otherwise use LexJson format.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the export was last updated.

resourceSpecification
  • Type: ExportResourceSpecification structure

A description of the type of resource that was exported, either a bot or a bot locale.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateIntent

$result = $client->updateIntent([/* ... */]);
$promise = $client->updateIntentAsync([/* ... */]);

Updates the settings for an intent.

Parameter Syntax

$result = $client->updateIntent([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false, // REQUIRED
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false, // REQUIRED
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false, // REQUIRED
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [ // REQUIRED
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentId' => '<string>', // REQUIRED
    'intentName' => '<string>', // REQUIRED
    'kendraConfiguration' => [
        'kendraIndex' => '<string>', // REQUIRED
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'localeId' => '<string>', // REQUIRED
    'outputContexts' => [
        [
            'name' => '<string>', // REQUIRED
            'timeToLiveInSeconds' => <integer>, // REQUIRED
            'turnsToLive' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'slotPriorities' => [
        [
            'priority' => <integer>, // REQUIRED
            'slotId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot that contains the intent.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the intent. Must be DRAFT.

description
  • Type: string

The new description of the intent.

dialogCodeHook
  • Type: DialogCodeHookSettings structure

The new Lambda function to use between each turn of the conversation with the bot.

fulfillmentCodeHook
  • Type: FulfillmentCodeHookSettings structure

The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

inputContexts
  • Type: Array of InputContext structures

A new list of contexts that must be active in order for Amazon Lex to consider the intent.

intentClosingSetting
  • Type: IntentClosingSetting structure

The new response that Amazon Lex sends the user when the intent is closed.

intentConfirmationSetting
  • Type: IntentConfirmationSetting structure

New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

intentId
  • Required: Yes
  • Type: string

The unique identifier of the intent to update.

intentName
  • Required: Yes
  • Type: string

The new name for the intent.

kendraConfiguration
  • Type: KendraConfiguration structure

New configuration settings for connecting to an Amazon Kendra index.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

outputContexts
  • Type: Array of OutputContext structures

A new list of contexts that Amazon Lex activates when the intent is fulfilled.

parentIntentSignature
  • Type: string

The signature of the new built-in intent to use as the parent of this intent.

sampleUtterances
  • Type: Array of SampleUtterance structures

New utterances used to invoke the intent.

slotPriorities
  • Type: Array of SlotPriority structures

A new list of slots and their priorities that are contained by the intent.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'dialogCodeHook' => [
        'enabled' => true || false,
    ],
    'fulfillmentCodeHook' => [
        'enabled' => true || false,
        'fulfillmentUpdatesSpecification' => [
            'active' => true || false,
            'startResponse' => [
                'allowInterrupt' => true || false,
                'delayInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutInSeconds' => <integer>,
            'updateResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'postFulfillmentStatusSpecification' => [
            'failureResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'successResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'timeoutResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'inputContexts' => [
        [
            'name' => '<string>',
        ],
        // ...
    ],
    'intentClosingSetting' => [
        'active' => true || false,
        'closingResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentConfirmationSetting' => [
        'active' => true || false,
        'declinationResponse' => [
            'allowInterrupt' => true || false,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
    ],
    'intentId' => '<string>',
    'intentName' => '<string>',
    'kendraConfiguration' => [
        'kendraIndex' => '<string>',
        'queryFilterString' => '<string>',
        'queryFilterStringEnabled' => true || false,
    ],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'outputContexts' => [
        [
            'name' => '<string>',
            'timeToLiveInSeconds' => <integer>,
            'turnsToLive' => <integer>,
        ],
        // ...
    ],
    'parentIntentSignature' => '<string>',
    'sampleUtterances' => [
        [
            'utterance' => '<string>',
        ],
        // ...
    ],
    'slotPriorities' => [
        [
            'priority' => <integer>,
            'slotId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the intent.

botVersion
  • Type: string

The version of the bot that contains the intent. Will always be DRAFT.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the intent was created.

description
  • Type: string

The updated description of the intent.

dialogCodeHook
  • Type: DialogCodeHookSettings structure

The updated Lambda function called during each turn of the conversation with the user.

fulfillmentCodeHook
  • Type: FulfillmentCodeHookSettings structure

The updated Lambda function called when the intent is ready for fulfillment.

inputContexts
  • Type: Array of InputContext structures

The updated list of contexts that must be active for the intent to be considered by Amazon Lex.

intentClosingSetting
  • Type: IntentClosingSetting structure

The updated response that Amazon Lex sends the user when the intent is closed.

intentConfirmationSetting
  • Type: IntentConfirmationSetting structure

The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.

intentId
  • Type: string

The identifier of the intent that was updated.

intentName
  • Type: string

The updated name of the intent.

kendraConfiguration
  • Type: KendraConfiguration structure

The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the last time that the intent was modified.

localeId
  • Type: string

The updated language and locale of the intent.

outputContexts
  • Type: Array of OutputContext structures

The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

parentIntentSignature
  • Type: string

The updated built-in intent that is the parent of this intent.

sampleUtterances
  • Type: Array of SampleUtterance structures

The updated list of sample utterances for the intent.

slotPriorities
  • Type: Array of SlotPriority structures

The updated list of slots and their priorities that are elicited from the user for the intent.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateResourcePolicy

$result = $client->updateResourcePolicy([/* ... */]);
$promise = $client->updateResourcePolicyAsync([/* ... */]);

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

Parameter Syntax

$result = $client->updateResourcePolicy([
    'expectedRevisionId' => '<string>',
    'policy' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
expectedRevisionId
  • Type: string

The identifier of the revision of the policy to update. If this revision ID doesn't match the current revision ID, Amazon Lex throws an exception.

If you don't specify a revision, Amazon Lex overwrites the contents of the policy with the new values.

policy
  • Required: Yes
  • Type: string

A resource policy to add to the resource. The policy is a JSON structure that contains one or more statements that define the policy. The policy must follow the IAM syntax. For more information about the contents of a JSON policy document, see IAM JSON policy reference .

If the policy isn't valid, Amazon Lex returns a validation exception.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

Result Syntax

[
    'resourceArn' => '<string>',
    'revisionId' => '<string>',
]

Result Details

Members
resourceArn
  • Type: string

The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.

revisionId
  • Type: string

The current revision of the resource policy. Use the revision ID to make sure that you are updating the most current version of a resource policy when you add a policy statement to a resource, delete a resource, or update a resource.

Errors

  • ResourceNotFoundException:

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

UpdateSlot

$result = $client->updateSlot([/* ... */]);
$promise = $client->updateSlotAsync([/* ... */]);

Updates the settings for a slot.

Parameter Syntax

$result = $client->updateSlot([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'intentId' => '<string>', // REQUIRED
    'localeId' => '<string>', // REQUIRED
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation', // REQUIRED
    ],
    'slotId' => '<string>', // REQUIRED
    'slotName' => '<string>', // REQUIRED
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [ // REQUIRED
        'defaultValueSpecification' => [
            'defaultValueList' => [ // REQUIRED
                [
                    'defaultValue' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>, // REQUIRED
            'messageGroups' => [ // REQUIRED
                [
                    'message' => [ // REQUIRED
                        'customPayload' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>', // REQUIRED
                                    'value' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>', // REQUIRED
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>', // REQUIRED
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional', // REQUIRED
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>, // REQUIRED
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>, // REQUIRED
            ],
            'waitingResponse' => [ // REQUIRED
                'allowInterrupt' => true || false,
                'messageGroups' => [ // REQUIRED
                    [
                        'message' => [ // REQUIRED
                            'customPayload' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>', // REQUIRED
                                        'value' => '<string>', // REQUIRED
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>', // REQUIRED
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>', // REQUIRED
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>', // REQUIRED
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>', // REQUIRED
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The unique identifier of the bot that contains the slot.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the slot. Must always be DRAFT.

description
  • Type: string

The new description for the slot.

intentId
  • Required: Yes
  • Type: string

The identifier of the intent that contains the slot.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.

multipleValuesSetting
  • Type: MultipleValuesSetting structure

Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.

obfuscationSetting
  • Type: ObfuscationSetting structure

New settings that determine how slot values are formatted in Amazon CloudWatch logs.

slotId
  • Required: Yes
  • Type: string

The unique identifier for the slot to update.

slotName
  • Required: Yes
  • Type: string

The new name for the slot.

slotTypeId
  • Type: string

The unique identifier of the new slot type to associate with this slot.

valueElicitationSetting
  • Required: Yes
  • Type: SlotValueElicitationSetting structure

A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'intentId' => '<string>',
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'multipleValuesSetting' => [
        'allowMultipleValues' => true || false,
    ],
    'obfuscationSetting' => [
        'obfuscationSettingType' => 'None|DefaultObfuscation',
    ],
    'slotId' => '<string>',
    'slotName' => '<string>',
    'slotTypeId' => '<string>',
    'valueElicitationSetting' => [
        'defaultValueSpecification' => [
            'defaultValueList' => [
                [
                    'defaultValue' => '<string>',
                ],
                // ...
            ],
        ],
        'promptSpecification' => [
            'allowInterrupt' => true || false,
            'maxRetries' => <integer>,
            'messageGroups' => [
                [
                    'message' => [
                        'customPayload' => [
                            'value' => '<string>',
                        ],
                        'imageResponseCard' => [
                            'buttons' => [
                                [
                                    'text' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'imageUrl' => '<string>',
                            'subtitle' => '<string>',
                            'title' => '<string>',
                        ],
                        'plainTextMessage' => [
                            'value' => '<string>',
                        ],
                        'ssmlMessage' => [
                            'value' => '<string>',
                        ],
                    ],
                    'variations' => [
                        [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        'sampleUtterances' => [
            [
                'utterance' => '<string>',
            ],
            // ...
        ],
        'slotConstraint' => 'Required|Optional',
        'waitAndContinueSpecification' => [
            'active' => true || false,
            'continueResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'stillWaitingResponse' => [
                'allowInterrupt' => true || false,
                'frequencyInSeconds' => <integer>,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'timeoutInSeconds' => <integer>,
            ],
            'waitingResponse' => [
                'allowInterrupt' => true || false,
                'messageGroups' => [
                    [
                        'message' => [
                            'customPayload' => [
                                'value' => '<string>',
                            ],
                            'imageResponseCard' => [
                                'buttons' => [
                                    [
                                        'text' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'imageUrl' => '<string>',
                                'subtitle' => '<string>',
                                'title' => '<string>',
                            ],
                            'plainTextMessage' => [
                                'value' => '<string>',
                            ],
                            'ssmlMessage' => [
                                'value' => '<string>',
                            ],
                        ],
                        'variations' => [
                            [
                                'customPayload' => [
                                    'value' => '<string>',
                                ],
                                'imageResponseCard' => [
                                    'buttons' => [
                                        [
                                            'text' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'imageUrl' => '<string>',
                                    'subtitle' => '<string>',
                                    'title' => '<string>',
                                ],
                                'plainTextMessage' => [
                                    'value' => '<string>',
                                ],
                                'ssmlMessage' => [
                                    'value' => '<string>',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the slot.

botVersion
  • Type: string

The identifier of the slot version that contains the slot. Will always be DRAFT.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the date and time that the slot was created.

description
  • Type: string

The updated description of the bot.

intentId
  • Type: string

The intent that contains the slot.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the date and time that the slot was last updated.

localeId
  • Type: string

The locale that contains the slot.

multipleValuesSetting
  • Type: MultipleValuesSetting structure

Indicates whether the slot accepts multiple values in one response.

obfuscationSetting
  • Type: ObfuscationSetting structure

The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.

slotId
  • Type: string

The unique identifier of the slot that was updated.

slotName
  • Type: string

The updated name of the slot.

slotTypeId
  • Type: string

The updated identifier of the slot type that provides values for the slot.

valueElicitationSetting
  • Type: SlotValueElicitationSetting structure

The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

UpdateSlotType

$result = $client->updateSlotType([/* ... */]);
$promise = $client->updateSlotTypeAsync([/* ... */]);

Updates the configuration of an existing slot type.

Parameter Syntax

$result = $client->updateSlotType([
    'botId' => '<string>', // REQUIRED
    'botVersion' => '<string>', // REQUIRED
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>', // REQUIRED
                's3ObjectKey' => '<string>', // REQUIRED
            ],
        ],
    ],
    'localeId' => '<string>', // REQUIRED
    'parentSlotTypeSignature' => '<string>',
    'slotTypeId' => '<string>', // REQUIRED
    'slotTypeName' => '<string>', // REQUIRED
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>', // REQUIRED
            ],
            'synonyms' => [
                [
                    'value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>', // REQUIRED
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution', // REQUIRED
    ],
]);

Parameter Details

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot that contains the slot type.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the slot type. Must be DRAFT.

description
  • Type: string

The new description of the slot type.

externalSourceSetting
  • Type: ExternalSourceSetting structure

Provides information about the external source of the slot type's definition.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

parentSlotTypeSignature
  • Type: string

The new built-in slot type that should be used as the parent of this slot type.

slotTypeId
  • Required: Yes
  • Type: string

The unique identifier of the slot type to update.

slotTypeName
  • Required: Yes
  • Type: string

The new name of the slot type.

slotTypeValues
  • Type: Array of SlotTypeValue structures

A new list of values and their optional synonyms that define the values that the slot type can take.

valueSelectionSetting
  • Type: SlotValueSelectionSetting structure

The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.

Result Syntax

[
    'botId' => '<string>',
    'botVersion' => '<string>',
    'creationDateTime' => <DateTime>,
    'description' => '<string>',
    'externalSourceSetting' => [
        'grammarSlotTypeSetting' => [
            'source' => [
                'kmsKeyArn' => '<string>',
                's3BucketName' => '<string>',
                's3ObjectKey' => '<string>',
            ],
        ],
    ],
    'lastUpdatedDateTime' => <DateTime>,
    'localeId' => '<string>',
    'parentSlotTypeSignature' => '<string>',
    'slotTypeId' => '<string>',
    'slotTypeName' => '<string>',
    'slotTypeValues' => [
        [
            'sampleValue' => [
                'value' => '<string>',
            ],
            'synonyms' => [
                [
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'valueSelectionSetting' => [
        'advancedRecognitionSetting' => [
            'audioRecognitionStrategy' => 'UseSlotValuesAsCustomVocabulary',
        ],
        'regexFilter' => [
            'pattern' => '<string>',
        ],
        'resolutionStrategy' => 'OriginalValue|TopResolution',
    ],
]

Result Details

Members
botId
  • Type: string

The identifier of the bot that contains the slot type.

botVersion
  • Type: string

The version of the bot that contains the slot type. This is always DRAFT.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the date and time that the slot type was created.

description
  • Type: string

The updated description of the slot type.

externalSourceSetting
  • Type: ExternalSourceSetting structure

Provides information about the external source of the slot type's definition.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the slot type was last updated.

localeId
  • Type: string

The language and locale of the updated slot type.

parentSlotTypeSignature
  • Type: string

The updated signature of the built-in slot type that is the parent of this slot type.

slotTypeId
  • Type: string

The unique identifier of the updated slot type.

slotTypeName
  • Type: string

The updated name of the slot type.

slotTypeValues
  • Type: Array of SlotTypeValue structures

The updated values that the slot type provides.

valueSelectionSetting
  • Type: SlotValueSelectionSetting structure

The updated strategy that Amazon Lex uses to determine which value to select from the slot type.

Errors

  • ThrottlingException:

    Your request rate is too high. Reduce the frequency of requests.

  • ServiceQuotaExceededException:

    You have reached a quota for your bot.

  • ValidationException:

    One of the input parameters in your request isn't valid. Check the parameters and try your request again.

  • PreconditionFailedException:

    Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

  • ConflictException:

    The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

  • InternalServerException:

    The service encountered an unexpected condition. Try your request again.

Shapes

AdvancedRecognitionSetting

Description

Provides settings that enable advanced recognition settings for slot values.

Members
audioRecognitionStrategy
  • Type: string

Enables using the slot values as a custom vocabulary for recognizing user utterances.

AggregatedUtterancesFilter

Description

Filters responses returned by the ListAggregatedUtterances operation.

Members
name
  • Required: Yes
  • Type: string

The name of the field to filter the utterance list.

operator
  • Required: Yes
  • Type: string

The operator to use for the filter. Specify EQ when the ListAggregatedUtterances operation should return only utterances that equal the specified value. Specify CO when the ListAggregatedUtterances operation should return utterances that contain the specified value.

values
  • Required: Yes
  • Type: Array of strings

The value to use for filtering the list of bots.

AggregatedUtterancesSortBy

Description

Specifies attributes for sorting a list of utterances.

Members
attribute
  • Required: Yes
  • Type: string

The utterance attribute to sort by.

order
  • Required: Yes
  • Type: string

Specifies whether to sort the aggregated utterances in ascending or descending order.

AggregatedUtterancesSummary

Description

Provides summary information for aggregated utterances. The ListAggregatedUtterances operations combines all instances of the same utterance into a single aggregated summary.

Members
containsDataFromDeletedResources
  • Type: boolean

Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.

hitCount
  • Type: int

The number of times that the utterance was detected by Amazon Lex during the time period. When an utterance is detected, it activates an intent or a slot.

missedCount
  • Type: int

The number of times that the utterance was missed by Amazon Lex An utterance is missed when it doesn't activate an intent or slot.

utterance
  • Type: string

The text of the utterance. If the utterance was used with the RecognizeUtterance operation, the text is the transcription of the audio utterance.

utteranceFirstRecordedInAggregationDuration
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the utterance was first recorded in the time window for aggregation. An utterance may have been sent to Amazon Lex before that time, but only utterances within the time window are counted.

utteranceLastRecordedInAggregationDuration
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The last date and time that an utterance was recorded in the time window for aggregation. An utterance may be sent to Amazon Lex after that time, but only utterances within the time window are counted.

AssociatedTranscript

Description

The object containing information that associates the recommended intent/slot type with a conversation.

Members
transcript
  • Type: string

The content of the transcript that meets the search filter criteria. For the JSON format of the transcript, see Output transcript format.

AssociatedTranscriptFilter

Description

Filters to search for the associated transcript.

Members
name
  • Required: Yes
  • Type: string

The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.

values
  • Required: Yes
  • Type: Array of strings

The values to use to filter the transcript.

AudioLogDestination

Description

The location of audio log files collected when conversation logging is enabled for a bot.

Members
s3Bucket
  • Required: Yes
  • Type: S3BucketLogDestination structure

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.

AudioLogSetting

Description

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.

Members
destination
  • Required: Yes
  • Type: AudioLogDestination structure

The location of audio log files collected when conversation logging is enabled for a bot.

enabled
  • Required: Yes
  • Type: boolean

Determines whether audio logging in enabled for the bot.

BotAliasHistoryEvent

Description

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.

Members
botVersion
  • Type: string

The version of the bot that was used in the event.

endDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event ended.

startDate
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the event started.

BotAliasLocaleSettings

Description

Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.

Members
codeHookSpecification
  • Type: CodeHookSpecification structure

Specifies the Lambda function that should be used in the locale.

enabled
  • Required: Yes
  • Type: boolean

Determines whether the locale is enabled for the bot. If the value is false, the locale isn't available for use.

BotAliasSummary

Description

Summary information about bot aliases returned from the ListBotAliases operation.

Members
botAliasId
  • Type: string

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
  • Type: string

The name of the bot alias.

botAliasStatus
  • Type: string

The current state of the bot alias. If the status is Available, the alias is ready for use.

botVersion
  • Type: string

The version of the bot that the bot alias references.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot alias was created.

description
  • Type: string

The description of the bot alias.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot alias was last updated.

BotExportSpecification

Description

Provides the identity of a the bot that was exported.

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot assigned by Amazon Lex.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that was exported. This will be either DRAFT or the version number.

BotFilter

Description

Filters the responses returned by the ListBots operation.

Members
name
  • Required: Yes
  • Type: string

The name of the field to filter the list of bots.

operator
  • Required: Yes
  • Type: string

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.

values
  • Required: Yes
  • Type: Array of strings

The value to use for filtering the list of bots.

BotImportSpecification

Description

Provides the bot parameters required for importing a bot.

Members
botName
  • Required: Yes
  • Type: string

The name that Amazon Lex should use for the bot.

botTags
  • Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to add to the bot. You can only add tags when you import a bot. You can't use the UpdateBot operation to update tags. To update tags, use the TagResource operation.

dataPrivacy
  • Required: Yes
  • Type: DataPrivacy structure

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.

idleSessionTTLInSeconds
  • Type: int

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.

roleArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the IAM role used to build and run the bot.

testBotAliasTags
  • Type: Associative array of custom strings keys (TagKey) to strings

A list of tags to add to the test alias for a bot. You can only add tags when you import a bot. You can't use the UpdateAlias operation to update tags. To update tags on the test alias, use the TagResource operation.

BotLocaleExportSpecification

Description

Provides the bot locale parameters required for exporting a bot locale.

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to create the locale for.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to export.

localeId
  • Required: Yes
  • Type: string

The identifier of the language and locale to export. The string must match one of the locales in the bot.

BotLocaleFilter

Description

Filters responses returned by the ListBotLocales operation.

Members
name
  • Required: Yes
  • Type: string

The name of the field to filter the list of bots.

operator
  • Required: Yes
  • Type: string

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.

values
  • Required: Yes
  • Type: Array of strings

The value to use for filtering the list of bots.

BotLocaleHistoryEvent

Description

Provides information about an event that occurred affecting the bot locale.

Members
event
  • Required: Yes
  • Type: string

A description of the event that occurred.

eventDate
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the event occurred.

BotLocaleImportSpecification

Description

Provides the bot locale parameters required for importing a bot locale.

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to import the locale to.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to import the locale to. This can only be the DRAFT version of the bot.

localeId
  • Required: Yes
  • Type: string

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 Supported languages.

nluIntentConfidenceThreshold
  • Type: double

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

voiceSettings
  • Type: VoiceSettings structure

Defines settings for using an Amazon Polly voice to communicate with a user.

BotLocaleSortBy

Description

Specifies attributes for sorting a list of bot locales.

Members
attribute
  • Required: Yes
  • Type: string

The bot locale attribute to sort by.

order
  • Required: Yes
  • Type: string

Specifies whether to sort the bot locales in ascending or descending order.

BotLocaleSummary

Description

Summary information about bot locales returned by the ListBotLocales operation.

Members
botLocaleStatus
  • Type: string

The current status of the bot locale. When the status is Built the locale is ready for use.

description
  • Type: string

The description of the bot locale.

lastBuildSubmittedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot locale was last built.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot locale was last updated.

localeId
  • Type: string

The language and locale of the bot locale.

localeName
  • Type: string

The name of the bot locale.

BotRecommendationResultStatistics

Description

A statistical summary of the bot recommendation results.

Members
intents
  • Type: IntentStatistics structure

Statistical information about about the intents associated with the bot recommendation results.

slotTypes
  • Type: SlotTypeStatistics structure

Statistical information about the slot types associated with the bot recommendation results.

BotRecommendationResults

Description

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

Members
associatedTranscriptsUrl
  • Type: string

The presigned url link of the associated transcript.

botLocaleExportUrl
  • Type: string

The presigned URL link of the recommended bot definition.

statistics
  • Type: BotRecommendationResultStatistics structure

The statistical summary of the bot recommendation results.

BotRecommendationSummary

Description

A summary of the bot recommendation.

Members
botRecommendationId
  • Required: Yes
  • Type: string

The unique identifier of the bot recommendation to be updated.

botRecommendationStatus
  • Required: Yes
  • Type: string

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot recommendation was created.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the bot recommendation was last updated.

BotSortBy

Description

Specifies attributes for sorting a list of bots.

Members
attribute
  • Required: Yes
  • Type: string

The attribute to use to sort the list of bots.

order
  • Required: Yes
  • Type: string

The order to sort the list. You can choose ascending or descending.

BotSummary

Description

Summary information about a bot returned by the ListBots operation.

Members
botId
  • Type: string

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

botName
  • Type: string

The name of the bot.

botStatus
  • Type: string

The current status of the bot. When the status is Available the bot is ready for use.

description
  • Type: string

The description of the bot.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the bot was last updated.

latestBotVersion
  • Type: string

The latest numerical version in use for the bot.

BotVersionLocaleDetails

Description

The version of a bot used for a bot locale.

Members
sourceBotVersion
  • Required: Yes
  • Type: string

The version of a bot used for a bot locale.

BotVersionSortBy

Description

Specifies attributes for sorting a list of bot versions.

Members
attribute
  • Required: Yes
  • Type: string

The attribute to use to sort the list of versions.

order
  • Required: Yes
  • Type: string

The order to sort the list. You can specify ascending or descending order.

BotVersionSummary

Description

Summary information about a bot version returned by the ListBotVersions operation.

Members
botName
  • Type: string

The name of the bot associated with the version.

botStatus
  • Type: string

The status of the bot. When the status is available, the version of the bot is ready for use.

botVersion
  • Type: string

The numeric version of the bot, or DRAFT to indicate that this is the version of the bot that can be updated..

creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the date and time that the version was created.

description
  • Type: string

The description of the version.

BuiltInIntentSortBy

Description

Specifies attributes for sorting a list of built-in intents.

Members
attribute
  • Required: Yes
  • Type: string

The attribute to use to sort the list of built-in intents.

order
  • Required: Yes
  • Type: string

The order to sort the list. You can specify ascending or descending order.

BuiltInIntentSummary

Description

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

Members
description
  • Type: string

The description of the intent.

intentSignature
  • Type: string

The signature of the built-in intent. Use this to specify the parent intent of a derived intent.

BuiltInSlotTypeSortBy

Description

Specifies attributes for sorting a list of built-in slot types.

Members
attribute
  • Required: Yes
  • Type: string

The attribute to use to sort the list of built-in intents.

order
  • Required: Yes
  • Type: string

The order to sort the list. You can choose ascending or descending.

BuiltInSlotTypeSummary

Description

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

Members
description
  • Type: string

The description of the built-in slot type.

slotTypeSignature
  • Type: string

The signature of the built-in slot type. Use this to specify the parent slot type of a derived slot type.

Button

Description

Describes a button to use on a response card used to gather slot values from a user.

Members
text
  • Required: Yes
  • Type: string

The text that appears on the button. Use this to tell the user what value is returned when they choose this button.

value
  • Required: Yes
  • Type: string

The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.

CloudWatchLogGroupLogDestination

Description

The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.

Members
cloudWatchLogGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

logPrefix
  • Required: Yes
  • Type: string

The prefix of the log stream name within the log group that you specified

CodeHookSpecification

Description

Contains information about code hooks that Amazon Lex calls during a conversation.

Members
lambdaCodeHook
  • Required: Yes
  • Type: LambdaCodeHook structure

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot.

ConflictException

Description

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

Members
message
  • Type: string

ConversationLogSettings

Description

Configures conversation logging that saves audio, text, and metadata for the conversations with your users.

Members
audioLogSettings
  • Type: Array of AudioLogSetting structures

The Amazon S3 settings for logging audio to an S3 bucket.

textLogSettings
  • Type: Array of TextLogSetting structures

The Amazon CloudWatch Logs settings for logging text and metadata.

CustomPayload

Description

A custom response string that Amazon Lex sends to your application. You define the content and structure the string.

Members
value
  • Required: Yes
  • Type: string

The string that is sent to your application.

CustomVocabularyExportSpecification

Description

Provides the parameters required for exporting a custom vocabulary.

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot that contains the custom vocabulary to export.

botVersion
  • Required: Yes
  • Type: string

The version of the bot that contains the custom vocabulary to export.

localeId
  • Required: Yes
  • Type: string

The locale of the bot that contains the custom vocabulary to export.

CustomVocabularyImportSpecification

Description

Provides the parameters required for importing a custom vocabulary.

Members
botId
  • Required: Yes
  • Type: string

The identifier of the bot to import the custom vocabulary to.

botVersion
  • Required: Yes
  • Type: string

The version of the bot to import the custom vocabulary to.

localeId
  • Required: Yes
  • Type: string

The identifier of the local to import the custom vocabulary to. The value must be en_GB.

DataPrivacy

Description

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.

Members
childDirected
  • Required: Yes
  • Type: boolean

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.

DateRangeFilter

Description

The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.

Members
endDateTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating the end date for the date range filter.

startDateTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp indicating the start date for the date range filter.

DialogCodeHookSettings

Description

Settings that determine the Lambda function that Amazon Lex uses for processing user responses.

Members
enabled
  • Required: Yes
  • Type: boolean

Enables the dialog code hook so that it processes user requests.

EncryptionSetting

Description

The object representing the passwords that were used to encrypt the data related to the bot recommendation, as well as the KMS key ARN used to encrypt the associated metadata.

Members
associatedTranscriptsPassword
  • Type: string

The password used to encrypt the associated transcript file.

botLocaleExportPassword
  • Type: string

The password used to encrypt the recommended bot recommendation file.

kmsKeyArn
  • Type: string

The KMS key ARN used to encrypt the metadata associated with the bot recommendation.

ExportFilter

Description

Filters the response form the ListExports operation

Members
name
  • Required: Yes
  • Type: string

The name of the field to use for filtering.

operator
  • Required: Yes
  • Type: string

The operator to use for the filter. Specify EQ when the ListExports operation should return only resource types that equal the specified value. Specify CO when the ListExports operation should return resource types that contain the specified value.

values
  • Required: Yes
  • Type: Array of strings

The values to use to filter the response. The values must be Bot, BotLocale, or CustomVocabulary.

ExportResourceSpecification

Description

Provides information about the bot or bot locale that you want to export. You can specify the botExportSpecification or the botLocaleExportSpecification, but not both.

Members
botExportSpecification
  • Type: BotExportSpecification structure

Parameters for exporting a bot.

botLocaleExportSpecification
  • Type: BotLocaleExportSpecification structure

Parameters for exporting a bot locale.

customVocabularyExportSpecification
  • Type: CustomVocabularyExportSpecification structure

The parameters required to export a custom vocabulary.

ExportSortBy

Description

Provides information about sorting a list of exports.

Members
attribute
  • Required: Yes
  • Type: string

The export field to use for sorting.

order
  • Required: Yes
  • Type: string

The order to sort the list.

ExportSummary

Description

Provides summary information about an export in an export list.

Members
creationDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the export was created.

exportId
  • Type: string

The unique identifier that Amazon Lex assigned to the export.

exportStatus
  • Type: string

The status of the export. When the status is Completed the export is ready to download.

fileFormat
  • Type: string

The file format used in the export files.

lastUpdatedDateTime
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the export was last updated.

resourceSpecification
  • Type: ExportResourceSpecification structure

Information about the bot or bot locale that was exported.

ExternalSourceSetting

Description

Provides information about the external source of the slot type's definition.

Members
grammarSlotTypeSetting
  • Type: GrammarSlotTypeSetting structure

Settings required for a slot type based on a grammar that you provide.

FulfillmentCodeHookSettings

Description

Determines if a Lambda function should be invoked for a specific intent.

Members
enabled
  • Required: Yes
  • Type: boolean

Indicates whether a Lambda function should be invoked to fulfill a specific intent.

fulfillmentUpdatesSpecification
  • Type: FulfillmentUpdatesSpecification structure

Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.