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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • Batch
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchLogs
      • 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
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • 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
    • Endpoint
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • Firehose
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • 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
    • 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
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • Kafka
      • Exception
    • kendra
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexRuntimeService
      • Exception
    • LicenseManager
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutforVision
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • ManagedBlockchain
      • 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
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrometheusService
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • Rekognition
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • 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
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • 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
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • 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\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • 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\Batch\BatchClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • 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\CloudWatchLogs\CloudWatchLogsClient
  • 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\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • 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\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • 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\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\Firehose\FirehoseClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • 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\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\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\kendra\kendraClient
  • 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\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • 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\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • 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\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrometheusService\PrometheusServiceClient
  • 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\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\Rekognition\RekognitionClient
  • 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\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\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\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • 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\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\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\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • 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\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\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • 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\Batch\Exception\BatchException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • 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\CloudWatchLogs\Exception\CloudWatchLogsException
  • 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\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • 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\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\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\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • 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\Firehose\Exception\FirehoseException
  • 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\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\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\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\Kafka\Exception\KafkaException
  • Aws\kendra\Exception\kendraException
  • 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\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • 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\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • 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\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • 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\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • 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\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\Rekognition\Exception\RekognitionException
  • 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\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\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • 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\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\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_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

Amazon Connect Service 2017-08-08

Client: Aws\Connect\ConnectClient
Service ID: connect
Version: 2017-08-08

This page describes the parameters and results for the operations of the Amazon Connect Service (2017-08-08), and shows how to use the Aws\Connect\ConnectClient object to call the described operations. This documentation is specific to the 2017-08-08 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 */).

  • AssociateApprovedOrigin ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • AssociateInstanceStorageConfig ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • AssociateLambdaFunction ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • AssociateLexBot ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • AssociateRoutingProfileQueues ( array $params = [] )

    Associates a set of queues with a routing profile.

  • AssociateSecurityKey ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • CreateContactFlow ( array $params = [] )

    Creates a contact flow for the specified Amazon Connect instance.

  • CreateInstance ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • CreateIntegrationAssociation ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • CreateQuickConnect ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • CreateRoutingProfile ( array $params = [] )

    Creates a new routing profile.

  • CreateUseCase ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • CreateUser ( array $params = [] )

    Creates a user account for the specified Amazon Connect instance.

  • CreateUserHierarchyGroup ( array $params = [] )

    Creates a new user hierarchy group.

  • DeleteInstance ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DeleteIntegrationAssociation ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DeleteQuickConnect ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DeleteUseCase ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DeleteUser ( array $params = [] )

    Deletes a user account from the specified Amazon Connect instance.

  • DeleteUserHierarchyGroup ( array $params = [] )

    Deletes an existing user hierarchy group.

  • DescribeContactFlow ( array $params = [] )

    Describes the specified contact flow.

  • DescribeInstance ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DescribeInstanceAttribute ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DescribeInstanceStorageConfig ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DescribeQuickConnect ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DescribeRoutingProfile ( array $params = [] )

    Describes the specified routing profile.

  • DescribeUser ( array $params = [] )

    Describes the specified user account.

  • DescribeUserHierarchyGroup ( array $params = [] )

    Describes the specified hierarchy group.

  • DescribeUserHierarchyStructure ( array $params = [] )

    Describes the hierarchy structure of the specified Amazon Connect instance.

  • DisassociateApprovedOrigin ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DisassociateInstanceStorageConfig ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DisassociateLambdaFunction ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DisassociateLexBot ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • DisassociateRoutingProfileQueues ( array $params = [] )

    Disassociates a set of queues from a routing profile.

  • DisassociateSecurityKey ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • GetContactAttributes ( array $params = [] )

    Retrieves the contact attributes for the specified contact.

  • GetCurrentMetricData ( array $params = [] )

    Gets the real-time metric data from the specified Amazon Connect instance.

  • GetFederationToken ( array $params = [] )

    Retrieves a token for federation.

  • GetMetricData ( array $params = [] )

    Gets historical metric data from the specified Amazon Connect instance.

  • ListApprovedOrigins ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListContactFlows ( array $params = [] )

    Provides information about the contact flows for the specified Amazon Connect instance.

  • ListHoursOfOperations ( array $params = [] )

    Provides information about the hours of operation for the specified Amazon Connect instance.

  • ListInstanceAttributes ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListInstanceStorageConfigs ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListInstances ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListIntegrationAssociations ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListLambdaFunctions ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListLexBots ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListPhoneNumbers ( array $params = [] )

    Provides information about the phone numbers for the specified Amazon Connect instance.

  • ListPrompts ( array $params = [] )

    Provides information about the prompts for the specified Amazon Connect instance.

  • ListQueues ( array $params = [] )

    Provides information about the queues for the specified Amazon Connect instance.

  • ListQuickConnects ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListRoutingProfileQueues ( array $params = [] )

    List the queues associated with a routing profile.

  • ListRoutingProfiles ( array $params = [] )

    Provides summary information about the routing profiles for the specified Amazon Connect instance.

  • ListSecurityKeys ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListSecurityProfiles ( array $params = [] )

    Provides summary information about the security profiles for the specified Amazon Connect instance.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for the specified resource.

  • ListUseCases ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • ListUserHierarchyGroups ( array $params = [] )

    Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

  • ListUsers ( array $params = [] )

    Provides summary information about the users for the specified Amazon Connect instance.

  • ResumeContactRecording ( array $params = [] )

    When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

  • StartChatContact ( array $params = [] )

    Initiates a contact flow to start a new chat for the customer.

  • StartContactRecording ( array $params = [] )

    This API starts recording the contact when the agent joins the call.

  • StartOutboundVoiceContact ( array $params = [] )

    This API places an outbound call to a contact, and then initiates the contact flow.

  • StartTaskContact ( array $params = [] )

    Initiates a contact flow to start a new task.

  • StopContact ( array $params = [] )

    Ends the specified contact.

  • StopContactRecording ( array $params = [] )

    When a contact is being recorded, this API stops recording the call.

  • SuspendContactRecording ( array $params = [] )

    When a contact is being recorded, this API suspends recording the call.

  • TagResource ( array $params = [] )

    Adds the specified tags to the specified resource.

  • UntagResource ( array $params = [] )

    Removes the specified tags from the specified resource.

  • UpdateContactAttributes ( array $params = [] )

    Creates or updates the contact attributes associated with the specified contact.

  • UpdateContactFlowContent ( array $params = [] )

    Updates the specified contact flow.

  • UpdateContactFlowName ( array $params = [] )

    The name of the contact flow.

  • UpdateInstanceAttribute ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • UpdateInstanceStorageConfig ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • UpdateQuickConnectConfig ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • UpdateQuickConnectName ( array $params = [] )

    This API is in preview release for Amazon Connect and is subject to change.

  • UpdateRoutingProfileConcurrency ( array $params = [] )

    Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

  • UpdateRoutingProfileDefaultOutboundQueue ( array $params = [] )

    Updates the default outbound queue of a routing profile.

  • UpdateRoutingProfileName ( array $params = [] )

    Updates the name and description of a routing profile.

  • UpdateRoutingProfileQueues ( array $params = [] )

    Updates the properties associated with a set of queues for a routing profile.

  • UpdateUserHierarchy ( array $params = [] )

    Assigns the specified hierarchy group to the specified user.

  • UpdateUserHierarchyGroupName ( array $params = [] )

    Updates the name of the user hierarchy group.

  • UpdateUserHierarchyStructure ( array $params = [] )

    Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

  • UpdateUserIdentityInfo ( array $params = [] )

    Updates the identity information for the specified user.

  • UpdateUserPhoneConfig ( array $params = [] )

    Updates the phone configuration settings for the specified user.

  • UpdateUserRoutingProfile ( array $params = [] )

    Assigns the specified routing profile to the specified user.

  • UpdateUserSecurityProfiles ( array $params = [] )

    Assigns the specified security profiles to the specified user.

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:

  • GetCurrentMetricData
  • GetMetricData
  • ListApprovedOrigins
  • ListContactFlows
  • ListHoursOfOperations
  • ListInstanceAttributes
  • ListInstanceStorageConfigs
  • ListInstances
  • ListIntegrationAssociations
  • ListLambdaFunctions
  • ListLexBots
  • ListPhoneNumbers
  • ListPrompts
  • ListQueues
  • ListQuickConnects
  • ListRoutingProfileQueues
  • ListRoutingProfiles
  • ListSecurityKeys
  • ListSecurityProfiles
  • ListUseCases
  • ListUserHierarchyGroups
  • ListUsers

Operations

AssociateApprovedOrigin

$result = $client->associateApprovedOrigin([/* ... */]);
$promise = $client->associateApprovedOriginAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect instance.

Parameter Syntax

$result = $client->associateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Origin
  • Required: Yes
  • Type: string

The domain to add to your allow list.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceConflictException:

    A resource already has that name.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

AssociateInstanceStorageConfig

$result = $client->associateInstanceStorageConfig([/* ... */]);
$promise = $client->associateInstanceStorageConfigAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an Amazon S3 bucket, exists when being used for association.

Parameter Syntax

$result = $client->associateInstanceStorageConfig([
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
    'StorageConfig' => [ // REQUIRED
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>', // REQUIRED
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>', // REQUIRED
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [ // REQUIRED
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
            'Prefix' => '<string>', // REQUIRED
            'RetentionPeriodHours' => <integer>, // REQUIRED
        ],
        'S3Config' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketPrefix' => '<string>', // REQUIRED
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', // REQUIRED
    ],
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

ResourceType
  • Required: Yes
  • Type: string

A valid resource type.

StorageConfig
  • Required: Yes
  • Type: InstanceStorageConfig structure

A valid storage type.

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Members
AssociationId
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceConflictException:

    A resource already has that name.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

AssociateLambdaFunction

$result = $client->associateLambdaFunction([/* ... */]);
$promise = $client->associateLambdaFunctionAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Lambda function.

Parameter Syntax

$result = $client->associateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FunctionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceConflictException:

    A resource already has that name.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

AssociateLexBot

$result = $client->associateLexBot([/* ... */]);
$promise = $client->associateLexBotAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.

Parameter Syntax

$result = $client->associateLexBot([
    'InstanceId' => '<string>', // REQUIRED
    'LexBot' => [ // REQUIRED
        'LexRegion' => '<string>',
        'Name' => '<string>',
    ],
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

LexBot
  • Required: Yes
  • Type: LexBot structure

The Amazon Lex box to associate with the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceConflictException:

    A resource already has that name.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

AssociateRoutingProfileQueues

$result = $client->associateRoutingProfileQueues([/* ... */]);
$promise = $client->associateRoutingProfileQueuesAsync([/* ... */]);

Associates a set of queues with a routing profile.

Parameter Syntax

$result = $client->associateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueConfigs' => [ // REQUIRED
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QueueConfigs
  • Required: Yes
  • Type: Array of RoutingProfileQueueConfig structures

The queues to associate with this routing profile.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

AssociateSecurityKey

$result = $client->associateSecurityKey([/* ... */]);
$promise = $client->associateSecurityKeyAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

Parameter Syntax

$result = $client->associateSecurityKey([
    'InstanceId' => '<string>', // REQUIRED
    'Key' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Key
  • Required: Yes
  • Type: string

A valid security key in PEM format.

Result Syntax

[
    'AssociationId' => '<string>',
]

Result Details

Members
AssociationId
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceConflictException:

    A resource already has that name.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

CreateContactFlow

$result = $client->createContactFlow([/* ... */]);
$promise = $client->createContactFlowAsync([/* ... */]);

Creates a contact flow for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->createContactFlow([
    'Content' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', // REQUIRED
]);

Parameter Details

Members
Content
  • Required: Yes
  • Type: string

The content of the contact flow.

Description
  • Type: string

The description of the contact flow.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Required: Yes
  • Type: string

The name of the contact flow.

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

One or more tags.

Type
  • Required: Yes
  • Type: string

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

Result Syntax

[
    'ContactFlowArn' => '<string>',
    'ContactFlowId' => '<string>',
]

Result Details

Members
ContactFlowArn
  • Type: string

The Amazon Resource Name (ARN) of the contact flow.

ContactFlowId
  • Type: string

The identifier of the contact flow.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidContactFlowException:

    The contact flow is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

CreateInstance

$result = $client->createInstance([/* ... */]);
$promise = $client->createInstanceAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage (such as Amazon S3, or Kinesis) or allow for any configurations on features such as Contact Lens for Amazon Connect.

Parameter Syntax

$result = $client->createInstance([
    'ClientToken' => '<string>',
    'DirectoryId' => '<string>',
    'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY', // REQUIRED
    'InboundCallsEnabled' => true || false, // REQUIRED
    'InstanceAlias' => '<string>',
    'OutboundCallsEnabled' => true || false, // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The idempotency token.

DirectoryId
  • Type: string

The identifier for the directory.

IdentityManagementType
  • Required: Yes
  • Type: string

The type of identity management for your Amazon Connect users.

InboundCallsEnabled
  • Required: Yes
  • Type: boolean

Whether your contact center handles incoming contacts.

InstanceAlias
  • Type: string

The name for your instance.

OutboundCallsEnabled
  • Required: Yes
  • Type: boolean

Whether your contact center allows outbound calls.

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
]

Result Details

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the instance.

Id
  • Type: string

The identifier for the instance.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

CreateIntegrationAssociation

$result = $client->createIntegrationAssociation([/* ... */]);
$promise = $client->createIntegrationAssociationAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Create an AppIntegration association with an Amazon Connect instance.

Parameter Syntax

$result = $client->createIntegrationAssociation([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationArn' => '<string>', // REQUIRED
    'IntegrationType' => 'EVENT', // REQUIRED
    'SourceApplicationName' => '<string>', // REQUIRED
    'SourceApplicationUrl' => '<string>', // REQUIRED
    'SourceType' => 'SALESFORCE|ZENDESK', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the integration.

IntegrationType
  • Required: Yes
  • Type: string

The type of information to be ingested.

SourceApplicationName
  • Required: Yes
  • Type: string

The name of the external application.

SourceApplicationUrl
  • Required: Yes
  • Type: string

The URL for the external application.

SourceType
  • Required: Yes
  • Type: string

The type of the data source.

Result Syntax

[
    'IntegrationAssociationArn' => '<string>',
    'IntegrationAssociationId' => '<string>',
]

Result Details

Members
IntegrationAssociationArn
  • Type: string

The Amazon Resource Name (ARN) for the association.

IntegrationAssociationId
  • Type: string

The identifier for the association.

Errors

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

CreateQuickConnect

$result = $client->createQuickConnect([/* ... */]);
$promise = $client->createQuickConnectAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Creates a quick connect for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->createQuickConnect([
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'QuickConnectConfig' => [ // REQUIRED
        'PhoneConfig' => [
            'PhoneNumber' => '<string>', // REQUIRED
        ],
        'QueueConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER', // REQUIRED
        'UserConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'UserId' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
  • Type: string

The description of the quick connect.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Required: Yes
  • Type: string

The name of the quick connect.

QuickConnectConfig
  • Required: Yes
  • Type: QuickConnectConfig structure

Configuration settings for the quick connect.

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

One or more tags.

Result Syntax

[
    'QuickConnectARN' => '<string>',
    'QuickConnectId' => '<string>',
]

Result Details

Members
QuickConnectARN
  • Type: string

The Amazon Resource Name (ARN) for the quick connect.

QuickConnectId
  • Type: string

The identifier for the quick connect.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

CreateRoutingProfile

$result = $client->createRoutingProfile([/* ... */]);
$promise = $client->createRoutingProfileAsync([/* ... */]);

Creates a new routing profile.

Parameter Syntax

$result = $client->createRoutingProfile([
    'DefaultOutboundQueueId' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'MediaConcurrencies' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'Concurrency' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'QueueConfigs' => [
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
DefaultOutboundQueueId
  • Required: Yes
  • Type: string

The default outbound queue for the routing profile.

Description
  • Required: Yes
  • Type: string

Description of the routing profile. Must not be more than 250 characters.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MediaConcurrencies
  • Required: Yes
  • Type: Array of MediaConcurrency structures

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

Name
  • Required: Yes
  • Type: string

The name of the routing profile. Must not be more than 127 characters.

QueueConfigs
  • Type: Array of RoutingProfileQueueConfig structures

The inbound queues associated with the routing profile. If no queue is added, the agent can only make outbound calls.

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

One or more tags.

Result Syntax

[
    'RoutingProfileArn' => '<string>',
    'RoutingProfileId' => '<string>',
]

Result Details

Members
RoutingProfileArn
  • Type: string

The Amazon Resource Name (ARN) of the routing profile.

RoutingProfileId
  • Type: string

The identifier of the routing profile.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

CreateUseCase

$result = $client->createUseCase([/* ... */]);
$promise = $client->createUseCaseAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Creates a use case for an AppIntegration association.

Parameter Syntax

$result = $client->createUseCase([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'UseCaseType' => 'RULES_EVALUATION', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationAssociationId
  • Required: Yes
  • Type: string

The identifier for the AppIntegration association.

UseCaseType
  • Required: Yes
  • Type: string

The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.

Result Syntax

[
    'UseCaseArn' => '<string>',
    'UseCaseId' => '<string>',
]

Result Details

Members
UseCaseArn
  • Type: string

The Amazon Resource Name (ARN) for the use case.

UseCaseId
  • Type: string

The identifier of the use case.

Errors

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->createUser([
    'DirectoryUserId' => '<string>',
    'HierarchyGroupId' => '<string>',
    'IdentityInfo' => [
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'Tags' => ['<string>', ...],
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
DirectoryUserId
  • Type: string

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

HierarchyGroupId
  • Type: string

The identifier of the hierarchy group for the user.

IdentityInfo
  • Type: UserIdentityInfo structure

The information about the identity of the user.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Password
  • Type: string

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

PhoneConfig
  • Required: Yes
  • Type: UserPhoneConfig structure

The phone settings for the user.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile for the user.

SecurityProfileIds
  • Required: Yes
  • Type: Array of strings

The identifier of the security profile for the user.

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

One or more tags.

Username
  • Required: Yes
  • Type: string

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.

Result Syntax

[
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members
UserArn
  • Type: string

The Amazon Resource Name (ARN) of the user account.

UserId
  • Type: string

The identifier of the user account.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

CreateUserHierarchyGroup

$result = $client->createUserHierarchyGroup([/* ... */]);
$promise = $client->createUserHierarchyGroupAsync([/* ... */]);

Creates a new user hierarchy group.

Parameter Syntax

$result = $client->createUserHierarchyGroup([
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ParentGroupId' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Required: Yes
  • Type: string

The name of the user hierarchy group. Must not be more than 100 characters.

ParentGroupId
  • Type: string

The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.

Result Syntax

[
    'HierarchyGroupArn' => '<string>',
    'HierarchyGroupId' => '<string>',
]

Result Details

Members
HierarchyGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the hierarchy group.

HierarchyGroupId
  • Type: string

The identifier of the hierarchy group.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DeleteInstance

$result = $client->deleteInstance([/* ... */]);
$promise = $client->deleteInstanceAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Deletes the Amazon Connect instance.

Parameter Syntax

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

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

DeleteIntegrationAssociation

$result = $client->deleteIntegrationAssociation([/* ... */]);
$promise = $client->deleteIntegrationAssociationAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.

Parameter Syntax

$result = $client->deleteIntegrationAssociation([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationAssociationId
  • Required: Yes
  • Type: string

The identifier for the AppIntegration association.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DeleteQuickConnect

$result = $client->deleteQuickConnect([/* ... */]);
$promise = $client->deleteQuickConnectAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Deletes a quick connect.

Parameter Syntax

$result = $client->deleteQuickConnect([
    'InstanceId' => '<string>', // REQUIRED
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QuickConnectId
  • Required: Yes
  • Type: string

The identifier for the quick connect.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DeleteUseCase

$result = $client->deleteUseCase([/* ... */]);
$promise = $client->deleteUseCaseAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Deletes a use case from an AppIntegration association.

Parameter Syntax

$result = $client->deleteUseCase([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'UseCaseId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationAssociationId
  • Required: Yes
  • Type: string

The identifier for the AppIntegration association.

UseCaseId
  • Required: Yes
  • Type: string

The identifier for the use case.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->deleteUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

UserId
  • Required: Yes
  • Type: string

The identifier of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DeleteUserHierarchyGroup

$result = $client->deleteUserHierarchyGroup([/* ... */]);
$promise = $client->deleteUserHierarchyGroupAsync([/* ... */]);

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

Parameter Syntax

$result = $client->deleteUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
HierarchyGroupId
  • Required: Yes
  • Type: string

The identifier of the hierarchy group.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceInUseException:

    That resource is already in use. Please try another.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeContactFlow

$result = $client->describeContactFlow([/* ... */]);
$promise = $client->describeContactFlowAsync([/* ... */]);

Describes the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->describeContactFlow([
    'ContactFlowId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'ContactFlow' => [
        'Arn' => '<string>',
        'Content' => '<string>',
        'Description' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Tags' => ['<string>', ...],
        'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
    ],
]

Result Details

Members
ContactFlow
  • Type: ContactFlow structure

Information about the contact flow.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ContactFlowNotPublishedException:

    The contact flow has not been published.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeInstance

$result = $client->describeInstance([/* ... */]);
$promise = $client->describeInstanceAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status if applicable.

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

Parameter Syntax

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

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'Instance' => [
        'Arn' => '<string>',
        'CreatedTime' => <DateTime>,
        'Id' => '<string>',
        'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
        'InboundCallsEnabled' => true || false,
        'InstanceAlias' => '<string>',
        'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
        'OutboundCallsEnabled' => true || false,
        'ServiceRole' => '<string>',
        'StatusReason' => [
            'Message' => '<string>',
        ],
    ],
]

Result Details

Members
Instance
  • Type: Instance structure

The name of the instance.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeInstanceAttribute

$result = $client->describeInstanceAttribute([/* ... */]);
$promise = $client->describeInstanceAttributeAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified instance attribute.

Parameter Syntax

$result = $client->describeInstanceAttribute([
    'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AttributeType
  • Required: Yes
  • Type: string

The type of attribute.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'Attribute' => [
        'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA',
        'Value' => '<string>',
    ],
]

Result Details

Members
Attribute
  • Type: Attribute structure

The type of attribute.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DescribeInstanceStorageConfig

$result = $client->describeInstanceStorageConfig([/* ... */]);
$promise = $client->describeInstanceStorageConfigAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

Parameter Syntax

$result = $client->describeInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Members
AssociationId
  • Required: Yes
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

ResourceType
  • Required: Yes
  • Type: string

A valid resource type.

Result Syntax

[
    'StorageConfig' => [
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>',
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>',
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
            'Prefix' => '<string>',
            'RetentionPeriodHours' => <integer>,
        ],
        'S3Config' => [
            'BucketName' => '<string>',
            'BucketPrefix' => '<string>',
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS',
                'KeyId' => '<string>',
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
    ],
]

Result Details

Members
StorageConfig
  • Type: InstanceStorageConfig structure

A valid storage type.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DescribeQuickConnect

$result = $client->describeQuickConnect([/* ... */]);
$promise = $client->describeQuickConnectAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Describes the quick connect.

Parameter Syntax

$result = $client->describeQuickConnect([
    'InstanceId' => '<string>', // REQUIRED
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QuickConnectId
  • Required: Yes
  • Type: string

The identifier for the quick connect.

Result Syntax

[
    'QuickConnect' => [
        'Description' => '<string>',
        'Name' => '<string>',
        'QuickConnectARN' => '<string>',
        'QuickConnectConfig' => [
            'PhoneConfig' => [
                'PhoneNumber' => '<string>',
            ],
            'QueueConfig' => [
                'ContactFlowId' => '<string>',
                'QueueId' => '<string>',
            ],
            'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER',
            'UserConfig' => [
                'ContactFlowId' => '<string>',
                'UserId' => '<string>',
            ],
        ],
        'QuickConnectId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
QuickConnect
  • Type: QuickConnect structure

Information about the quick connect.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeRoutingProfile

$result = $client->describeRoutingProfile([/* ... */]);
$promise = $client->describeRoutingProfileAsync([/* ... */]);

Describes the specified routing profile.

Parameter Syntax

$result = $client->describeRoutingProfile([
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[
    'RoutingProfile' => [
        'DefaultOutboundQueueId' => '<string>',
        'Description' => '<string>',
        'InstanceId' => '<string>',
        'MediaConcurrencies' => [
            [
                'Channel' => 'VOICE|CHAT|TASK',
                'Concurrency' => <integer>,
            ],
            // ...
        ],
        'Name' => '<string>',
        'RoutingProfileArn' => '<string>',
        'RoutingProfileId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members
RoutingProfile
  • Type: RoutingProfile structure

The routing profile.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

Parameter Syntax

$result = $client->describeUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[
    'User' => [
        'Arn' => '<string>',
        'DirectoryUserId' => '<string>',
        'HierarchyGroupId' => '<string>',
        'Id' => '<string>',
        'IdentityInfo' => [
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
        ],
        'PhoneConfig' => [
            'AfterContactWorkTimeLimit' => <integer>,
            'AutoAccept' => true || false,
            'DeskPhoneNumber' => '<string>',
            'PhoneType' => 'SOFT_PHONE|DESK_PHONE',
        ],
        'RoutingProfileId' => '<string>',
        'SecurityProfileIds' => ['<string>', ...],
        'Tags' => ['<string>', ...],
        'Username' => '<string>',
    ],
]

Result Details

Members
User
  • Type: User structure

Information about the user account and configuration settings.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeUserHierarchyGroup

$result = $client->describeUserHierarchyGroup([/* ... */]);
$promise = $client->describeUserHierarchyGroupAsync([/* ... */]);

Describes the specified hierarchy group.

Parameter Syntax

$result = $client->describeUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
HierarchyGroupId
  • Required: Yes
  • Type: string

The identifier of the hierarchy group.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'HierarchyGroup' => [
        'Arn' => '<string>',
        'HierarchyPath' => [
            'LevelFive' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelFour' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelOne' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelThree' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelTwo' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'LevelId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members
HierarchyGroup
  • Type: HierarchyGroup structure

Information about the hierarchy group.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DescribeUserHierarchyStructure

$result = $client->describeUserHierarchyStructure([/* ... */]);
$promise = $client->describeUserHierarchyStructureAsync([/* ... */]);

Describes the hierarchy structure of the specified Amazon Connect instance.

Parameter Syntax

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

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'HierarchyStructure' => [
        'LevelFive' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelFour' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelOne' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelThree' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelTwo' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Members
HierarchyStructure
  • Type: HierarchyStructure structure

Information about the hierarchy structure.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DisassociateApprovedOrigin

$result = $client->disassociateApprovedOrigin([/* ... */]);
$promise = $client->disassociateApprovedOriginAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

Parameter Syntax

$result = $client->disassociateApprovedOrigin([
    'InstanceId' => '<string>', // REQUIRED
    'Origin' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Origin
  • Required: Yes
  • Type: string

The domain URL of the integrated application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DisassociateInstanceStorageConfig

$result = $client->disassociateInstanceStorageConfig([/* ... */]);
$promise = $client->disassociateInstanceStorageConfigAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

Parameter Syntax

$result = $client->disassociateInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Members
AssociationId
  • Required: Yes
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

ResourceType
  • Required: Yes
  • Type: string

A valid resource type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DisassociateLambdaFunction

$result = $client->disassociateLambdaFunction([/* ... */]);
$promise = $client->disassociateLambdaFunctionAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Remove the Lambda function from the drop-down options available in the relevant contact flow blocks.

Parameter Syntax

$result = $client->disassociateLambdaFunction([
    'FunctionArn' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
FunctionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the Lambda function being disassociated.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance..

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DisassociateLexBot

$result = $client->disassociateLexBot([/* ... */]);
$promise = $client->disassociateLexBotAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

Parameter Syntax

$result = $client->disassociateLexBot([
    'BotName' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'LexRegion' => '<string>', // REQUIRED
]);

Parameter Details

Members
BotName
  • Required: Yes
  • Type: string

The name of the Amazon Lex bot. Maximum character limit of 50.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

LexRegion
  • Required: Yes
  • Type: string

The Region in which the Amazon Lex bot has been created.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

DisassociateRoutingProfileQueues

$result = $client->disassociateRoutingProfileQueues([/* ... */]);
$promise = $client->disassociateRoutingProfileQueuesAsync([/* ... */]);

Disassociates a set of queues from a routing profile.

Parameter Syntax

$result = $client->disassociateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueReferences' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QueueReferences
  • Required: Yes
  • Type: Array of RoutingProfileQueueReference structures

The queues to disassociate from this routing profile.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

DisassociateSecurityKey

$result = $client->disassociateSecurityKey([/* ... */]);
$promise = $client->disassociateSecurityKeyAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Deletes the specified security key.

Parameter Syntax

$result = $client->disassociateSecurityKey([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
AssociationId
  • Required: Yes
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

GetContactAttributes

$result = $client->getContactAttributes([/* ... */]);
$promise = $client->getContactAttributesAsync([/* ... */]);

Retrieves the contact attributes for the specified contact.

Parameter Syntax

$result = $client->getContactAttributes([
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InitialContactId
  • Required: Yes
  • Type: string

The identifier of the initial contact.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

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

Result Details

Members
Attributes
  • Type: Associative array of custom strings keys (AttributeName) to strings

Information about the attributes.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

GetCurrentMetricData

$result = $client->getCurrentMetricData([/* ... */]);
$promise = $client->getCurrentMetricDataAsync([/* ... */]);

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->getCurrentMetricData([
    'CurrentMetrics' => [ // REQUIRED
        [
            'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
CurrentMetrics
  • Required: Yes
  • Type: Array of CurrentMetric structures

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 }

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

Filters
  • Required: Yes
  • Type: Filters structure

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

Groupings
  • Type: Array of strings

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.

If no Grouping is included in the request, a summary of metrics is returned.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Result Syntax

[
    'DataSnapshotTime' => <DateTime>,
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE',
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT|TASK',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

The time at which the metrics were retrieved and cached for pagination.

MetricResults
  • Type: Array of CurrentMetricResult structures

Information about the real-time metrics.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • ResourceNotFoundException:

    The specified resource was not found.

GetFederationToken

$result = $client->getFederationToken([/* ... */]);
$promise = $client->getFederationTokenAsync([/* ... */]);

Retrieves a token for federation.

Parameter Syntax

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

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[
    'Credentials' => [
        'AccessToken' => '<string>',
        'AccessTokenExpiration' => <DateTime>,
        'RefreshToken' => '<string>',
        'RefreshTokenExpiration' => <DateTime>,
    ],
]

Result Details

Members
Credentials
  • Type: Credentials structure

The credentials to use for federation.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • UserNotFoundException:

    No user with the specified credentials was found in the Amazon Connect instance.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • DuplicateResourceException:

    A resource with the specified name already exists.

GetMetricData

$result = $client->getMetricData([/* ... */]);
$promise = $client->getMetricDataAsync([/* ... */]);

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->getMetricData([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'HistoricalMetrics' => [ // REQUIRED
        [
            'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
            'Statistic' => 'SUM|MAX|AVG',
            'Threshold' => [
                'Comparison' => 'LT',
                'ThresholdValue' => <float>,
            ],
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members
EndTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Filters
  • Required: Yes
  • Type: Filters structure

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.

Groupings
  • Type: Array of strings

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

The only supported grouping is QUEUE.

If no grouping is specified, a summary of metrics for all queues is returned.

HistoricalMetrics
  • Required: Yes
  • Type: Array of HistoricalMetric structures

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

Unit: PERCENT

Statistic: AVG

Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

StartTime
  • Required: Yes
  • Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Result Syntax

[
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
                        'Statistic' => 'SUM|MAX|AVG',
                        'Threshold' => [
                            'Comparison' => 'LT',
                            'ThresholdValue' => <float>,
                        ],
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE|CHAT|TASK',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MetricResults
  • Type: Array of HistoricalMetricResult structures

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • ResourceNotFoundException:

    The specified resource was not found.

ListApprovedOrigins

$result = $client->listApprovedOrigins([/* ... */]);
$promise = $client->listApprovedOriginsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

Parameter Syntax

$result = $client->listApprovedOrigins([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Origins' => ['<string>', ...],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Origins
  • Type: Array of strings

The approved origins.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListContactFlows

$result = $client->listContactFlows([/* ... */]);
$promise = $client->listContactFlowsAsync([/* ... */]);

Provides information about the contact flows for the specified Amazon Connect instance.

You can also create and update contact flows using the Amazon Connect Flow language.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listContactFlows([
    'ContactFlowTypes' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ContactFlowTypes
  • Type: Array of strings

The type of contact flow.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'ContactFlowSummaryList' => [
        [
            'Arn' => '<string>',
            'ContactFlowType' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ContactFlowSummaryList
  • Type: Array of ContactFlowSummary structures

Information about the contact flows.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListHoursOfOperations

$result = $client->listHoursOfOperations([/* ... */]);
$promise = $client->listHoursOfOperationsAsync([/* ... */]);

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listHoursOfOperations([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'HoursOfOperationSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
HoursOfOperationSummaryList
  • Type: Array of HoursOfOperationSummary structures

Information about the hours of operation.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListInstanceAttributes

$result = $client->listInstanceAttributes([/* ... */]);
$promise = $client->listInstanceAttributesAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

Parameter Syntax

$result = $client->listInstanceAttributes([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'Attributes' => [
        [
            'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA',
            'Value' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Attributes
  • Type: Array of Attribute structures

The attribute types.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListInstanceStorageConfigs

$result = $client->listInstanceStorageConfigs([/* ... */]);
$promise = $client->listInstanceStorageConfigsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

Parameter Syntax

$result = $client->listInstanceStorageConfigs([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ResourceType
  • Required: Yes
  • Type: string

A valid resource type.

Result Syntax

[
    'NextToken' => '<string>',
    'StorageConfigs' => [
        [
            'AssociationId' => '<string>',
            'KinesisFirehoseConfig' => [
                'FirehoseArn' => '<string>',
            ],
            'KinesisStreamConfig' => [
                'StreamArn' => '<string>',
            ],
            'KinesisVideoStreamConfig' => [
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
                'Prefix' => '<string>',
                'RetentionPeriodHours' => <integer>,
            ],
            'S3Config' => [
                'BucketName' => '<string>',
                'BucketPrefix' => '<string>',
                'EncryptionConfig' => [
                    'EncryptionType' => 'KMS',
                    'KeyId' => '<string>',
                ],
            ],
            'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

StorageConfigs
  • Type: Array of InstanceStorageConfig structures

A valid storage type.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListInstances

$result = $client->listInstances([/* ... */]);
$promise = $client->listInstancesAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

Parameter Syntax

$result = $client->listInstances([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'InstanceSummaryList' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'Id' => '<string>',
            'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY',
            'InboundCallsEnabled' => true || false,
            'InstanceAlias' => '<string>',
            'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED',
            'OutboundCallsEnabled' => true || false,
            'ServiceRole' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
InstanceSummaryList
  • Type: Array of InstanceSummary structures

Information about the instances.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListIntegrationAssociations

$result = $client->listIntegrationAssociations([/* ... */]);
$promise = $client->listIntegrationAssociationsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listIntegrationAssociations([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'IntegrationAssociationSummaryList' => [
        [
            'InstanceId' => '<string>',
            'IntegrationArn' => '<string>',
            'IntegrationAssociationArn' => '<string>',
            'IntegrationAssociationId' => '<string>',
            'IntegrationType' => 'EVENT',
            'SourceApplicationName' => '<string>',
            'SourceApplicationUrl' => '<string>',
            'SourceType' => 'SALESFORCE|ZENDESK',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
IntegrationAssociationSummaryList
  • Type: Array of IntegrationAssociationSummary structures

The AppIntegration associations.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListLambdaFunctions

$result = $client->listLambdaFunctions([/* ... */]);
$promise = $client->listLambdaFunctionsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Lambda functions that show up in the drop-down options in the relevant contact flow blocks.

Parameter Syntax

$result = $client->listLambdaFunctions([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'LambdaFunctions' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
LambdaFunctions
  • Type: Array of strings

The Lambdafunction ARNs associated with the specified instance.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListLexBots

$result = $client->listLexBots([/* ... */]);
$promise = $client->listLexBotsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex bots currently associated with the instance.

Parameter Syntax

$result = $client->listLexBots([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'LexBots' => [
        [
            'LexRegion' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LexBots
  • Type: Array of LexBot structures

The the names and regions of the Amazon Lex bots associated with the specified instance.

NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListPhoneNumbers

$result = $client->listPhoneNumbers([/* ... */]);
$promise = $client->listPhoneNumbersAsync([/* ... */]);

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listPhoneNumbers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberCountryCodes' => ['<string>', ...],
    'PhoneNumberTypes' => ['<string>', ...],
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

PhoneNumberCountryCodes
  • Type: Array of strings

The ISO country code.

PhoneNumberTypes
  • Type: Array of strings

The type of phone number.

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumberSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'PhoneNumber' => '<string>',
            'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW',
            'PhoneNumberType' => 'TOLL_FREE|DID',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

PhoneNumberSummaryList
  • Type: Array of PhoneNumberSummary structures

Information about the phone numbers.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListPrompts

$result = $client->listPrompts([/* ... */]);
$promise = $client->listPromptsAsync([/* ... */]);

Provides information about the prompts for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listPrompts([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PromptSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

PromptSummaryList
  • Type: Array of PromptSummary structures

Information about the prompts.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListQueues

$result = $client->listQueues([/* ... */]);
$promise = $client->listQueuesAsync([/* ... */]);

Provides information about the queues for the specified Amazon Connect instance.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QueueTypes' => ['<string>', ...],
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QueueTypes
  • Type: Array of strings

The type of queue.

Result Syntax

[
    'NextToken' => '<string>',
    'QueueSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QueueType' => 'STANDARD|AGENT',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

QueueSummaryList
  • Type: Array of QueueSummary structures

Information about the queues.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListQuickConnects

$result = $client->listQuickConnects([/* ... */]);
$promise = $client->listQuickConnectsAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Provides information about the quick connects for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listQuickConnects([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QuickConnectTypes' => ['<string>', ...],
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

QuickConnectTypes
  • Type: Array of strings

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Result Syntax

[
    'NextToken' => '<string>',
    'QuickConnectSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

QuickConnectSummaryList
  • Type: Array of QuickConnectSummary structures

Information about the quick connects.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListRoutingProfileQueues

$result = $client->listRoutingProfileQueues([/* ... */]);
$promise = $client->listRoutingProfileQueuesAsync([/* ... */]);

List the queues associated with a routing profile.

Parameter Syntax

$result = $client->listRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingProfileQueueConfigSummaryList' => [
        [
            'Channel' => 'VOICE|CHAT|TASK',
            'Delay' => <integer>,
            'Priority' => <integer>,
            'QueueArn' => '<string>',
            'QueueId' => '<string>',
            'QueueName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

RoutingProfileQueueConfigSummaryList
  • Type: Array of RoutingProfileQueueConfigSummary structures

Information about the routing profiles.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListRoutingProfiles

$result = $client->listRoutingProfiles([/* ... */]);
$promise = $client->listRoutingProfilesAsync([/* ... */]);

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listRoutingProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

RoutingProfileSummaryList
  • Type: Array of RoutingProfileSummary structures

Information about the routing profiles.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListSecurityKeys

$result = $client->listSecurityKeys([/* ... */]);
$promise = $client->listSecurityKeysAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all security keys associated with the instance.

Parameter Syntax

$result = $client->listSecurityKeys([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityKeys' => [
        [
            'AssociationId' => '<string>',
            'CreationTime' => <DateTime>,
            'Key' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

SecurityKeys
  • Type: Array of SecurityKey structures

The security keys.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListSecurityProfiles

$result = $client->listSecurityProfiles([/* ... */]);
$promise = $client->listSecurityProfilesAsync([/* ... */]);

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

SecurityProfileSummaryList
  • Type: Array of SecurityProfileSummary structures

Information about the security profiles.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListTagsForResource

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

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

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

Result Details

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

Information about the tags.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListUseCases

$result = $client->listUseCases([/* ... */]);
$promise = $client->listUseCasesAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

List the use cases.

Parameter Syntax

$result = $client->listUseCases([
    'InstanceId' => '<string>', // REQUIRED
    'IntegrationAssociationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationAssociationId
  • Required: Yes
  • Type: string

The identifier for the integration association.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UseCaseSummaryList' => [
        [
            'UseCaseArn' => '<string>',
            'UseCaseId' => '<string>',
            'UseCaseType' => 'RULES_EVALUATION',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

UseCaseSummaryList
  • Type: Array of UseCase structures

The use cases.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

ListUserHierarchyGroups

$result = $client->listUserHierarchyGroups([/* ... */]);
$promise = $client->listUserHierarchyGroupsAsync([/* ... */]);

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->listUserHierarchyGroups([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UserHierarchyGroupSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

UserHierarchyGroupSummaryList
  • Type: Array of HierarchyGroupSummary structures

Information about the hierarchy groups.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Provides summary information about the users for the specified Amazon Connect instance.

Parameter Syntax

$result = $client->listUsers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MaxResults
  • Type: int

The maximimum number of results to return per page.

NextToken
  • Type: string

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Result Syntax

[
    'NextToken' => '<string>',
    'UserSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

If there are additional results, this is the token for the next set of results.

UserSummaryList
  • Type: Array of UserSummary structures

Information about the users.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

ResumeContactRecording

$result = $client->resumeContactRecording([/* ... */]);
$promise = $client->resumeContactRecordingAsync([/* ... */]);

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.

Only voice recordings are supported at this time.

Parameter Syntax

$result = $client->resumeContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactId
  • Required: Yes
  • Type: string

The identifier of the contact.

InitialContactId
  • Required: Yes
  • Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

StartChatContact

$result = $client->startChatContact([/* ... */]);
$promise = $client->startChatContactAsync([/* ... */]);

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->startChatContact([
    'Attributes' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'InitialMessage' => [
        'Content' => '<string>', // REQUIRED
        'ContentType' => '<string>', // REQUIRED
    ],
    'InstanceId' => '<string>', // REQUIRED
    'ParticipantDetails' => [ // REQUIRED
        'DisplayName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
Attributes
  • Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ClientToken
  • Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

InitialMessage
  • Type: ChatMessage structure

The initial message to be sent to the newly created chat.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

ParticipantDetails
  • Required: Yes
  • Type: ParticipantDetails structure

Information identifying the participant.

Result Syntax

[
    'ContactId' => '<string>',
    'ParticipantId' => '<string>',
    'ParticipantToken' => '<string>',
]

Result Details

Members
ContactId
  • Type: string

The identifier of this contact within the Amazon Connect instance.

ParticipantId
  • Type: string

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

ParticipantToken
  • Type: string

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

StartContactRecording

$result = $client->startContactRecording([/* ... */]);
$promise = $client->startContactRecordingAsync([/* ... */]);

This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

Parameter Syntax

$result = $client->startContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'VoiceRecordingConfiguration' => [ // REQUIRED
        'VoiceRecordingTrack' => 'FROM_AGENT|TO_AGENT|ALL',
    ],
]);

Parameter Details

Members
ContactId
  • Required: Yes
  • Type: string

The identifier of the contact.

InitialContactId
  • Required: Yes
  • Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

VoiceRecordingConfiguration
  • Required: Yes
  • Type: VoiceRecordingConfiguration structure

Who is being recorded.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

StartOutboundVoiceContact

$result = $client->startOutboundVoiceContact([/* ... */]);
$promise = $client->startOutboundVoiceContactAsync([/* ... */]);

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->startOutboundVoiceContact([
    'Attributes' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'DestinationPhoneNumber' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>',
    'SourcePhoneNumber' => '<string>',
]);

Parameter Details

Members
Attributes
  • Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ClientToken
  • Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.

ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

DestinationPhoneNumber
  • Required: Yes
  • Type: string

The phone number of the customer, in E.164 format.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QueueId
  • Type: string

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

SourcePhoneNumber
  • Type: string

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

Result Syntax

[
    'ContactId' => '<string>',
]

Result Details

Members
ContactId
  • Type: string

The identifier of this contact within the Amazon Connect instance.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • LimitExceededException:

    The allowed limit for the resource has been exceeded.

  • DestinationNotAllowedException:

    Outbound calls to the destination number are not allowed.

  • OutboundContactNotPermittedException:

    The contact is not permitted.

StartTaskContact

$result = $client->startTaskContact([/* ... */]);
$promise = $client->startTaskContactAsync([/* ... */]);

Initiates a contact flow to start a new task.

Parameter Syntax

$result = $client->startTaskContact([
    'Attributes' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'PreviousContactId' => '<string>',
    'References' => [
        '<ReferenceKey>' => [
            'Type' => 'URL', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Attributes
  • Type: Associative array of custom strings keys (AttributeName) to strings

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

ClientToken
  • Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Description
  • Type: string

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Required: Yes
  • Type: string

The name of a task that is shown to an agent in the Contact Control Panel (CCP).

PreviousContactId
  • Type: string

The identifier of the previous chat, voice, or task contact.

References
  • Type: Associative array of custom strings keys (ReferenceKey) to Reference structures

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

Result Syntax

[
    'ContactId' => '<string>',
]

Result Details

Members
ContactId
  • Type: string

The identifier of this contact within the Amazon Connect instance.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • ServiceQuotaExceededException:

    The service quota has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

StopContact

$result = $client->stopContact([/* ... */]);
$promise = $client->stopContactAsync([/* ... */]);

Ends the specified contact.

Parameter Syntax

$result = $client->stopContact([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactId
  • Required: Yes
  • Type: string

The ID of the contact.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ContactNotFoundException:

    The contact with the specified ID is not active or does not exist.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

StopContactRecording

$result = $client->stopContactRecording([/* ... */]);
$promise = $client->stopContactRecordingAsync([/* ... */]);

When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

Parameter Syntax

$result = $client->stopContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactId
  • Required: Yes
  • Type: string

The identifier of the contact.

InitialContactId
  • Required: Yes
  • Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

SuspendContactRecording

$result = $client->suspendContactRecording([/* ... */]);
$promise = $client->suspendContactRecordingAsync([/* ... */]);

When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording.

The period of time that the recording is suspended is filled with silence in the final recording.

Only voice recordings are supported at this time.

Parameter Syntax

$result = $client->suspendContactRecording([
    'ContactId' => '<string>', // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactId
  • Required: Yes
  • Type: string

The identifier of the contact.

InitialContactId
  • Required: Yes
  • Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds the specified tags to the specified resource.

The supported resource types are users, routing profiles, quick connects, and contact flows.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

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

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

One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified resource.

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.

tagKeys
  • Required: Yes
  • Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

UpdateContactAttributes

$result = $client->updateContactAttributes([/* ... */]);
$promise = $client->updateContactAttributesAsync([/* ... */]);

Creates or updates the contact attributes associated with the specified contact.

You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Parameter Syntax

$result = $client->updateContactAttributes([
    'Attributes' => ['<string>', ...], // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Attributes
  • Required: Yes
  • Type: Associative array of custom strings keys (AttributeName) to strings

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

InitialContactId
  • Required: Yes
  • Type: string

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateContactFlowContent

$result = $client->updateContactFlowContent([/* ... */]);
$promise = $client->updateContactFlowContentAsync([/* ... */]);

Updates the specified contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->updateContactFlowContent([
    'ContactFlowId' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow.

Content
  • Required: Yes
  • Type: string

The JSON string that represents contact flow’s content. For an example, see Example contact flow in Amazon Connect Flow language in the Amazon Connect Administrator Guide.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidContactFlowException:

    The contact flow is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateContactFlowName

$result = $client->updateContactFlowName([/* ... */]);
$promise = $client->updateContactFlowNameAsync([/* ... */]);

The name of the contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Parameter Syntax

$result = $client->updateContactFlowName([
    'ContactFlowId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members
ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow.

Description
  • Type: string

The description of the contact flow.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Type: string

The name of the contact flow.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateInstanceAttribute

$result = $client->updateInstanceAttribute([/* ... */]);
$promise = $client->updateInstanceAttributeAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Updates the value for the specified attribute type.

Parameter Syntax

$result = $client->updateInstanceAttribute([
    'AttributeType' => 'INBOUND_CALLS|OUTBOUND_CALLS|CONTACTFLOW_LOGS|CONTACT_LENS|AUTO_RESOLVE_BEST_VOICES|USE_CUSTOM_TTS_VOICES|EARLY_MEDIA', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'Value' => '<string>', // REQUIRED
]);

Parameter Details

Members
AttributeType
  • Required: Yes
  • Type: string

The type of attribute.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Value
  • Required: Yes
  • Type: string

The value for the attribute. Maximum character limit is 100.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

UpdateInstanceStorageConfig

$result = $client->updateInstanceStorageConfig([/* ... */]);
$promise = $client->updateInstanceStorageConfigAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

Parameter Syntax

$result = $client->updateInstanceStorageConfig([
    'AssociationId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ResourceType' => 'CHAT_TRANSCRIPTS|CALL_RECORDINGS|SCHEDULED_REPORTS|MEDIA_STREAMS|CONTACT_TRACE_RECORDS|AGENT_EVENTS', // REQUIRED
    'StorageConfig' => [ // REQUIRED
        'AssociationId' => '<string>',
        'KinesisFirehoseConfig' => [
            'FirehoseArn' => '<string>', // REQUIRED
        ],
        'KinesisStreamConfig' => [
            'StreamArn' => '<string>', // REQUIRED
        ],
        'KinesisVideoStreamConfig' => [
            'EncryptionConfig' => [ // REQUIRED
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
            'Prefix' => '<string>', // REQUIRED
            'RetentionPeriodHours' => <integer>, // REQUIRED
        ],
        'S3Config' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketPrefix' => '<string>', // REQUIRED
            'EncryptionConfig' => [
                'EncryptionType' => 'KMS', // REQUIRED
                'KeyId' => '<string>', // REQUIRED
            ],
        ],
        'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', // REQUIRED
    ],
]);

Parameter Details

Members
AssociationId
  • Required: Yes
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

ResourceType
  • Required: Yes
  • Type: string

A valid resource type.

StorageConfig
  • Required: Yes
  • Type: InstanceStorageConfig structure

The storage configuration for the instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The specified resource was not found.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ThrottlingException:

    The throttling limit has been exceeded.

UpdateQuickConnectConfig

$result = $client->updateQuickConnectConfig([/* ... */]);
$promise = $client->updateQuickConnectConfigAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Updates the configuration settings for the specified quick connect.

Parameter Syntax

$result = $client->updateQuickConnectConfig([
    'InstanceId' => '<string>', // REQUIRED
    'QuickConnectConfig' => [ // REQUIRED
        'PhoneConfig' => [
            'PhoneNumber' => '<string>', // REQUIRED
        ],
        'QueueConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'QueueId' => '<string>', // REQUIRED
        ],
        'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER', // REQUIRED
        'UserConfig' => [
            'ContactFlowId' => '<string>', // REQUIRED
            'UserId' => '<string>', // REQUIRED
        ],
    ],
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QuickConnectConfig
  • Required: Yes
  • Type: QuickConnectConfig structure

Information about the configuration settings for the quick connect.

QuickConnectId
  • Required: Yes
  • Type: string

The identifier for the quick connect.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateQuickConnectName

$result = $client->updateQuickConnectName([/* ... */]);
$promise = $client->updateQuickConnectNameAsync([/* ... */]);

This API is in preview release for Amazon Connect and is subject to change.

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least Name or Description must be provided.

Parameter Syntax

$result = $client->updateQuickConnectName([
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'QuickConnectId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string

The description of the quick connect.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Type: string

The name of the quick connect.

QuickConnectId
  • Required: Yes
  • Type: string

The identifier for the quick connect.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateRoutingProfileConcurrency

$result = $client->updateRoutingProfileConcurrency([/* ... */]);
$promise = $client->updateRoutingProfileConcurrencyAsync([/* ... */]);

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

Parameter Syntax

$result = $client->updateRoutingProfileConcurrency([
    'InstanceId' => '<string>', // REQUIRED
    'MediaConcurrencies' => [ // REQUIRED
        [
            'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
            'Concurrency' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

MediaConcurrencies
  • Required: Yes
  • Type: Array of MediaConcurrency structures

The channels agents can handle in the Contact Control Panel (CCP).

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateRoutingProfileDefaultOutboundQueue

$result = $client->updateRoutingProfileDefaultOutboundQueue([/* ... */]);
$promise = $client->updateRoutingProfileDefaultOutboundQueueAsync([/* ... */]);

Updates the default outbound queue of a routing profile.

Parameter Syntax

$result = $client->updateRoutingProfileDefaultOutboundQueue([
    'DefaultOutboundQueueId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DefaultOutboundQueueId
  • Required: Yes
  • Type: string

The identifier for the default outbound queue.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateRoutingProfileName

$result = $client->updateRoutingProfileName([/* ... */]);
$promise = $client->updateRoutingProfileNameAsync([/* ... */]);

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

Parameter Syntax

$result = $client->updateRoutingProfileName([
    'Description' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string

The description of the routing profile. Must not be more than 250 characters.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Type: string

The name of the routing profile. Must not be more than 127 characters.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateRoutingProfileQueues

$result = $client->updateRoutingProfileQueues([/* ... */]);
$promise = $client->updateRoutingProfileQueuesAsync([/* ... */]);

Updates the properties associated with a set of queues for a routing profile.

Parameter Syntax

$result = $client->updateRoutingProfileQueues([
    'InstanceId' => '<string>', // REQUIRED
    'QueueConfigs' => [ // REQUIRED
        [
            'Delay' => <integer>, // REQUIRED
            'Priority' => <integer>, // REQUIRED
            'QueueReference' => [ // REQUIRED
                'Channel' => 'VOICE|CHAT|TASK', // REQUIRED
                'QueueId' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

QueueConfigs
  • Required: Yes
  • Type: Array of RoutingProfileQueueConfig structures

The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserHierarchy

$result = $client->updateUserHierarchy([/* ... */]);
$promise = $client->updateUserHierarchyAsync([/* ... */]);

Assigns the specified hierarchy group to the specified user.

Parameter Syntax

$result = $client->updateUserHierarchy([
    'HierarchyGroupId' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
HierarchyGroupId
  • Type: string

The identifier of the hierarchy group.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserHierarchyGroupName

$result = $client->updateUserHierarchyGroupName([/* ... */]);
$promise = $client->updateUserHierarchyGroupNameAsync([/* ... */]);

Updates the name of the user hierarchy group.

Parameter Syntax

$result = $client->updateUserHierarchyGroupName([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
HierarchyGroupId
  • Required: Yes
  • Type: string

The identifier of the hierarchy group.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Name
  • Required: Yes
  • Type: string

The name of the hierarchy group. Must not be more than 100 characters.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • DuplicateResourceException:

    A resource with the specified name already exists.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserHierarchyStructure

$result = $client->updateUserHierarchyStructure([/* ... */]);
$promise = $client->updateUserHierarchyStructureAsync([/* ... */]);

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

Parameter Syntax

$result = $client->updateUserHierarchyStructure([
    'HierarchyStructure' => [ // REQUIRED
        'LevelFive' => [
            'Name' => '<string>', // REQUIRED
        ],
        'LevelFour' => [
            'Name' => '<string>', // REQUIRED
        ],
        'LevelOne' => [
            'Name' => '<string>', // REQUIRED
        ],
        'LevelThree' => [
            'Name' => '<string>', // REQUIRED
        ],
        'LevelTwo' => [
            'Name' => '<string>', // REQUIRED
        ],
    ],
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
HierarchyStructure
  • Required: Yes
  • Type: HierarchyStructureUpdate structure

The hierarchy levels to update.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ResourceInUseException:

    That resource is already in use. Please try another.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserIdentityInfo

$result = $client->updateUserIdentityInfo([/* ... */]);
$promise = $client->updateUserIdentityInfoAsync([/* ... */]);

Updates the identity information for the specified user.

Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->updateUserIdentityInfo([
    'IdentityInfo' => [ // REQUIRED
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
IdentityInfo
  • Required: Yes
  • Type: UserIdentityInfo structure

The identity information for the user.

InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserPhoneConfig

$result = $client->updateUserPhoneConfig([/* ... */]);
$promise = $client->updateUserPhoneConfigAsync([/* ... */]);

Updates the phone configuration settings for the specified user.

Parameter Syntax

$result = $client->updateUserPhoneConfig([
    'InstanceId' => '<string>', // REQUIRED
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

PhoneConfig
  • Required: Yes
  • Type: UserPhoneConfig structure

Information about phone configuration settings for the user.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserRoutingProfile

$result = $client->updateUserRoutingProfile([/* ... */]);
$promise = $client->updateUserRoutingProfileAsync([/* ... */]);

Assigns the specified routing profile to the specified user.

Parameter Syntax

$result = $client->updateUserRoutingProfile([
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

RoutingProfileId
  • Required: Yes
  • Type: string

The identifier of the routing profile for the user.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

UpdateUserSecurityProfiles

$result = $client->updateUserSecurityProfiles([/* ... */]);
$promise = $client->updateUserSecurityProfilesAsync([/* ... */]);

Assigns the specified security profiles to the specified user.

Parameter Syntax

$result = $client->updateUserSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members
InstanceId
  • Required: Yes
  • Type: string

The identifier of the Amazon Connect instance.

SecurityProfileIds
  • Required: Yes
  • Type: Array of strings

The identifiers of the security profiles for the user.

UserId
  • Required: Yes
  • Type: string

The identifier of the user account.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request is not valid.

  • InvalidParameterException:

    One or more of the specified parameters are not valid.

  • ResourceNotFoundException:

    The specified resource was not found.

  • ThrottlingException:

    The throttling limit has been exceeded.

  • InternalServiceException:

    Request processing failed due to an error or failure with the service.

Shapes

Attribute

Description

A toggle for an individual feature at the instance level.

Members
AttributeType
  • Type: string

The type of attribute.

Value
  • Type: string

The value of the attribute.

ChatMessage

Description

A chat message.

Members
Content
  • Required: Yes
  • Type: string

The content of the chat message.

ContentType
  • Required: Yes
  • Type: string

The type of the content. Supported types are text/plain.

ContactFlow

Description

Contains information about a contact flow.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the contact flow.

Content
  • Type: string

The content of the contact flow.

Description
  • Type: string

The description of the contact flow.

Id
  • Type: string

The identifier of the contact flow.

Name
  • Type: string

The name of the contact flow.

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

One or more tags.

Type
  • Type: string

The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.

ContactFlowNotPublishedException

Description

The contact flow has not been published.

Members
Message
  • Type: string

ContactFlowSummary

Description

Contains summary information about a contact flow.

You can also create and update contact flows using the Amazon Connect Flow language.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the contact flow.

ContactFlowType
  • Type: string

The type of contact flow.

Id
  • Type: string

The identifier of the contact flow.

Name
  • Type: string

The name of the contact flow.

ContactNotFoundException

Description

The contact with the specified ID is not active or does not exist.

Members
Message
  • Type: string

The message.

Credentials

Description

Contains credentials to use for federation.

Members
AccessToken
  • Type: string

An access token generated for a federated user to access Amazon Connect.

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

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

RefreshToken
  • Type: string

Renews a token generated for a user to access the Amazon Connect instance.

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

Renews the expiration timer for a generated token.

CurrentMetric

Description

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

Members
Name
  • Type: string

The name of the metric.

Unit
  • Type: string

The unit for the metric.

CurrentMetricData

Description

Contains the data for a real-time metric.

Members
Metric
  • Type: CurrentMetric structure

Information about the metric.

Value
  • Type: double

The value of the metric.

CurrentMetricResult

Description

Contains information about a set of real-time metrics.

Members
Collections
  • Type: Array of CurrentMetricData structures

The set of metrics.

Dimensions
  • Type: Dimensions structure

The dimensions for the metrics.

DestinationNotAllowedException

Description

Outbound calls to the destination number are not allowed.

Members
Message
  • Type: string

The message.

Dimensions

Description

Contains information about the dimensions for a set of metrics.

Members
Channel
  • Type: string

The channel used for grouping and filters.

Queue
  • Type: QueueReference structure

Information about the queue for which metrics are returned.

DuplicateResourceException

Description

A resource with the specified name already exists.

Members
Message
  • Type: string

EncryptionConfig

Description

The encryption configuration.

Members
EncryptionType
  • Required: Yes
  • Type: string

The type of encryption.

KeyId
  • Required: Yes
  • Type: string

The identifier of the encryption key.

Filters

Description

Contains the filter to apply when retrieving metrics.

Members
Channels
  • Type: Array of strings

The channel to use to filter the metrics.

Queues
  • Type: Array of strings

The queues to use to filter the metrics. You can specify up to 100 queues per request.

HierarchyGroup

Description

Contains information about a hierarchy group.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the hierarchy group.

HierarchyPath
  • Type: HierarchyPath structure

Information about the levels in the hierarchy group.

Id
  • Type: string

The identifier of the hierarchy group.

LevelId
  • Type: string

The identifier of the level in the hierarchy group.

Name
  • Type: string

The name of the hierarchy group.

HierarchyGroupSummary

Description

Contains summary information about a hierarchy group.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the hierarchy group.

Id
  • Type: string

The identifier of the hierarchy group.

Name
  • Type: string

The name of the hierarchy group.

HierarchyLevel

Description

Contains information about a hierarchy level.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the hierarchy level.

Id
  • Type: string

The identifier of the hierarchy level.

Name
  • Type: string

The name of the hierarchy level.

HierarchyLevelUpdate

Description

Contains information about the hierarchy level to update.

Members
Name
  • Required: Yes
  • Type: string

The name of the user hierarchy level. Must not be more than 50 characters.

HierarchyPath

Description

Contains information about the levels of a hierarchy group.

Members
LevelFive
  • Type: HierarchyGroupSummary structure

Information about level five.

LevelFour
  • Type: HierarchyGroupSummary structure

Information about level four.

LevelOne
  • Type: HierarchyGroupSummary structure

Information about level one.

LevelThree
  • Type: HierarchyGroupSummary structure

Information about level three.

LevelTwo
  • Type: HierarchyGroupSummary structure

Information about level two.

HierarchyStructure

Description

Contains information about a hierarchy structure.

Members
LevelFive
  • Type: HierarchyLevel structure

Information about level five.

LevelFour
  • Type: HierarchyLevel structure

Information about level four.

LevelOne
  • Type: HierarchyLevel structure

Information about level one.

LevelThree
  • Type: HierarchyLevel structure

Information about level three.

LevelTwo
  • Type: HierarchyLevel structure

Information about level two.

HierarchyStructureUpdate

Description

Contains information about the level hierarchy to update.

Members
LevelFive
  • Type: HierarchyLevelUpdate structure

The update for level five.

LevelFour
  • Type: HierarchyLevelUpdate structure

The update for level four.

LevelOne
  • Type: HierarchyLevelUpdate structure

The update for level one.

LevelThree
  • Type: HierarchyLevelUpdate structure

The update for level three.

LevelTwo
  • Type: HierarchyLevelUpdate structure

The update for level two.

HistoricalMetric

Description

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

Members
Name
  • Type: string

The name of the metric.

Statistic
  • Type: string

The statistic for the metric.

Threshold
  • Type: Threshold structure

The threshold for the metric, used with service level metrics.

Unit
  • Type: string

The unit for the metric.

HistoricalMetricData

Description

Contains the data for a historical metric.

Members
Metric
  • Type: HistoricalMetric structure

Information about the metric.

Value
  • Type: double

The value of the metric.

HistoricalMetricResult

Description

Contains information about the historical metrics retrieved.

Members
Collections
  • Type: Array of HistoricalMetricData structures

The set of metrics.

Dimensions
  • Type: Dimensions structure

The dimension for the metrics.

HoursOfOperationSummary

Description

Contains summary information about hours of operation for a contact center.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the hours of operation.

Id
  • Type: string

The identifier of the hours of operation.

Name
  • Type: string

The name of the hours of operation.

Instance

Description

The Amazon Connect instance.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the instance.

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

When the instance was created.

Id
  • Type: string

The identifier of the Amazon Connect instance.

IdentityManagementType
  • Type: string

The identity management type.

InboundCallsEnabled
  • Type: boolean

Whether inbound calls are enabled.

InstanceAlias
  • Type: string

The alias of instance.

InstanceStatus
  • Type: string

The state of the instance.

OutboundCallsEnabled
  • Type: boolean

Whether outbound calls are enabled.

ServiceRole
  • Type: string

The service role of the instance.

StatusReason
  • Type: InstanceStatusReason structure

Relevant details why the instance was not successfully created.

InstanceStatusReason

Description

Relevant details why the instance was not successfully created.

Members
Message
  • Type: string

The message.

InstanceStorageConfig

Description

The storage configuration for the instance.

Members
AssociationId
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

KinesisFirehoseConfig
  • Type: KinesisFirehoseConfig structure

The configuration of the Kinesis Firehose delivery stream.

KinesisStreamConfig
  • Type: KinesisStreamConfig structure

The configuration of the Kinesis data stream.

KinesisVideoStreamConfig
  • Type: KinesisVideoStreamConfig structure

The configuration of the Kinesis video stream.

S3Config
  • Type: S3Config structure

The S3 configuration.

StorageType
  • Required: Yes
  • Type: string

A valid storage type.

InstanceSummary

Description

Information about the instance.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the instance.

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

When the instance was created.

Id
  • Type: string

The identifier of the instance.

IdentityManagementType
  • Type: string

The identity management type of the instance.

InboundCallsEnabled
  • Type: boolean

Whether inbound calls are enabled.

InstanceAlias
  • Type: string

The alias of the instance.

InstanceStatus
  • Type: string

The state of the instance.

OutboundCallsEnabled
  • Type: boolean

Whether outbound calls are enabled.

ServiceRole
  • Type: string

The service role of the instance.

IntegrationAssociationSummary

Description

Contains summary information about the associated AppIntegrations.

Members
InstanceId
  • Type: string

The identifier of the Amazon Connect instance.

IntegrationArn
  • Type: string

The Amazon Resource Name (ARN) for the AppIntegration.

IntegrationAssociationArn
  • Type: string

The Amazon Resource Name (ARN) for the AppIntegration association.

IntegrationAssociationId
  • Type: string

The identifier for the AppIntegration association.

IntegrationType
  • Type: string

The integration type.

SourceApplicationName
  • Type: string

The user-provided, friendly name for the external application.

SourceApplicationUrl
  • Type: string

The URL for the external application.

SourceType
  • Type: string

The name of the source.

InternalServiceException

Description

Request processing failed due to an error or failure with the service.

Members
Message
  • Type: string

The message.

InvalidContactFlowException

Description

The contact flow is not valid.

Members
problems
  • Type: Array of ProblemDetail structures

The problems with the contact flow. Please fix before trying again.

InvalidParameterException

Description

One or more of the specified parameters are not valid.

Members
Message
  • Type: string

The message.

InvalidRequestException

Description

The request is not valid.

Members
Message
  • Type: string

The message.

KinesisFirehoseConfig

Description

Configuration information of a Kinesis Firehose delivery stream.

Members
FirehoseArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the delivery stream.

KinesisStreamConfig

Description

Configuration information of a Kinesis data stream.

Members
StreamArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the data stream.

KinesisVideoStreamConfig

Description

Configuration information of a Kinesis video stream.

Members
EncryptionConfig
  • Required: Yes
  • Type: EncryptionConfig structure

The encryption configuration.

Prefix
  • Required: Yes
  • Type: string

The prefix of the video stream.

RetentionPeriodHours
  • Required: Yes
  • Type: int

The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

LexBot

Description

Configuration information of an Amazon Lex bot.

Members
LexRegion
  • Type: string

The Region the Amazon Lex bot was created in.

Name
  • Type: string

The name of the Amazon Lex bot.

LimitExceededException

Description

The allowed limit for the resource has been exceeded.

Members
Message
  • Type: string

The message.

MediaConcurrency

Description

Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

Members
Channel
  • Required: Yes
  • Type: string

The channels that agents can handle in the Contact Control Panel (CCP).

Concurrency
  • Required: Yes
  • Type: int

The number of contacts an agent can have on a channel simultaneously.

OutboundContactNotPermittedException

Description

The contact is not permitted.

Members
Message
  • Type: string

The message.

ParticipantDetails

Description

The customer's details.

Members
DisplayName
  • Required: Yes
  • Type: string

Display name of the participant.

PhoneNumberQuickConnectConfig

Description

Contains information about a phone number for a quick connect.

Members
PhoneNumber
  • Required: Yes
  • Type: string

The phone number in E.164 format.

PhoneNumberSummary

Description

Contains summary information about a phone number for a contact center.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the phone number.

Id
  • Type: string

The identifier of the phone number.

PhoneNumber
  • Type: string

The phone number.

PhoneNumberCountryCode
  • Type: string

The ISO country code.

PhoneNumberType
  • Type: string

The type of phone number.

ProblemDetail

Description

Information about a problem detail.

Members
message
  • Type: string

The problem detail's message.

PromptSummary

Description

Contains information about the prompt.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the prompt.

Id
  • Type: string

The identifier of the prompt.

Name
  • Type: string

The name of the prompt.

QueueQuickConnectConfig

Description

Contains information about a queue for a quick connect. The contact flow must be of type Transfer to Queue.

Members
ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow.

QueueId
  • Required: Yes
  • Type: string

The identifier of the queue.

QueueReference

Description

Contains information about a queue resource for which metrics are returned.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the queue.

Id
  • Type: string

The identifier of the queue.

QueueSummary

Description

Contains summary information about a queue.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the queue.

Id
  • Type: string

The identifier of the queue.

Name
  • Type: string

The name of the queue.

QueueType
  • Type: string

The type of queue.

QuickConnect

Description

Contains information about a quick connect.

Members
Description
  • Type: string

The description.

Name
  • Type: string

The name of the quick connect.

QuickConnectARN
  • Type: string

The Amazon Resource Name (ARN) of the quick connect.

QuickConnectConfig
  • Type: QuickConnectConfig structure

Contains information about the quick connect.

QuickConnectId
  • Type: string

The identifier for the quick connect.

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

One or more tags.

QuickConnectConfig

Description

Contains configuration settings for a quick connect.

Members
PhoneConfig
  • Type: PhoneNumberQuickConnectConfig structure

The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.

QueueConfig
  • Type: QueueQuickConnectConfig structure

The queue configuration. This is required only if QuickConnectType is QUEUE.

QuickConnectType
  • Required: Yes
  • Type: string

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

UserConfig
  • Type: UserQuickConnectConfig structure

The user configuration. This is required only if QuickConnectType is USER.

QuickConnectSummary

Description

Contains summary information about a quick connect.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN).

Id
  • Type: string

The identifier for the quick connect.

Name
  • Type: string

The name.

QuickConnectType
  • Type: string

The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Reference

Description

A link that an agent selects to complete a given task. You can have up to 4,096 UTF-8 bytes across all references for a contact.

Members
Type
  • Required: Yes
  • Type: string

A valid URL.

Value
  • Required: Yes
  • Type: string

A formatted URL that will be shown to an agent in the Contact Control Panel (CCP)

ResourceConflictException

Description

A resource already has that name.

Members
Message
  • Type: string

ResourceInUseException

Description

That resource is already in use. Please try another.

Members
Message
  • Type: string
ResourceId
  • Type: string

The identifier for the resource.

ResourceType
  • Type: string

The type of resource.

ResourceNotFoundException

Description

The specified resource was not found.

Members
Message
  • Type: string

The message.

RoutingProfile

Description

Contains information about a routing profile.

Members
DefaultOutboundQueueId
  • Type: string

The identifier of the default outbound queue for this routing profile.

Description
  • Type: string

The description of the routing profile.

InstanceId
  • Type: string

The identifier of the Amazon Connect instance.

MediaConcurrencies
  • Type: Array of MediaConcurrency structures

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

Name
  • Type: string

The name of the routing profile.

RoutingProfileArn
  • Type: string

The Amazon Resource Name (ARN) of the routing profile.

RoutingProfileId
  • Type: string

The identifier of the routing profile.

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

One or more tags.

RoutingProfileQueueConfig

Description

Contains information about the queue and channel for which priority and delay can be set.

Members
Delay
  • Required: Yes
  • Type: int

The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

Priority
  • Required: Yes
  • Type: int

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

QueueReference
  • Required: Yes
  • Type: RoutingProfileQueueReference structure

Contains information about a queue resource.

RoutingProfileQueueConfigSummary

Description

Contains summary information about a routing profile queue.

Members
Channel
  • Required: Yes
  • Type: string

The channels this queue supports.

Delay
  • Required: Yes
  • Type: int

The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

Priority
  • Required: Yes
  • Type: int

The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

QueueArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the queue.

QueueId
  • Required: Yes
  • Type: string

The identifier of the queue.

QueueName
  • Required: Yes
  • Type: string

The name of the queue.

RoutingProfileQueueReference

Description

Contains the channel and queue identifier for a routing profile.

Members
Channel
  • Required: Yes
  • Type: string

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

QueueId
  • Required: Yes
  • Type: string

The identifier of the queue.

RoutingProfileSummary

Description

Contains summary information about a routing profile.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the routing profile.

Id
  • Type: string

The identifier of the routing profile.

Name
  • Type: string

The name of the routing profile.

S3Config

Description

Information about the S3 storage type.

Members
BucketName
  • Required: Yes
  • Type: string

The S3 bucket name.

BucketPrefix
  • Required: Yes
  • Type: string

The S3 bucket prefix.

EncryptionConfig
  • Type: EncryptionConfig structure

The S3 encryption configuration.

SecurityKey

Description

Configuration information of the security key.

Members
AssociationId
  • Type: string

The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.

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

When the security key was created.

Key
  • Type: string

The key of the security key.

SecurityProfileSummary

Description

Contains information about a security profile.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the security profile.

Id
  • Type: string

The identifier of the security profile.

Name
  • Type: string

The name of the security profile.

ServiceQuotaExceededException

Description

The service quota has been exceeded.

Members
Message
  • Type: string

Threshold

Description

Contains information about the threshold for service level metrics.

Members
Comparison
  • Type: string

The type of comparison. Only "less than" (LT) comparisons are supported.

ThresholdValue
  • Type: double

The threshold value to compare.

ThrottlingException

Description

The throttling limit has been exceeded.

Members
Message
  • Type: string

UseCase

Description

Contains the use case.

Members
UseCaseArn
  • Type: string

The Amazon Resource Name (ARN) for the use case.

UseCaseId
  • Type: string

The identifier for the use case.

UseCaseType
  • Type: string

The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.

User

Description

Contains information about a user account for a Amazon Connect instance.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the user account.

DirectoryUserId
  • Type: string

The identifier of the user account in the directory used for identity management.

HierarchyGroupId
  • Type: string

The identifier of the hierarchy group for the user.

Id
  • Type: string

The identifier of the user account.

IdentityInfo
  • Type: UserIdentityInfo structure

Information about the user identity.

PhoneConfig
  • Type: UserPhoneConfig structure

Information about the phone configuration for the user.

RoutingProfileId
  • Type: string

The identifier of the routing profile for the user.

SecurityProfileIds
  • Type: Array of strings

The identifiers of the security profiles for the user.

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

The tags.

Username
  • Type: string

The user name assigned to the user account.

UserIdentityInfo

Description

Contains information about the identity of a user.

Members
Email
  • Type: string

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

FirstName
  • Type: string

The first name. This is required if you are using Amazon Connect or SAML for identity management.

LastName
  • Type: string

The last name. This is required if you are using Amazon Connect or SAML for identity management.

UserNotFoundException

Description

No user with the specified credentials was found in the Amazon Connect instance.

Members
Message
  • Type: string

UserPhoneConfig

Description

Contains information about the phone configuration settings for a user.

Members
AfterContactWorkTimeLimit
  • Type: int

The After Call Work (ACW) timeout setting, in seconds.

AutoAccept
  • Type: boolean

The Auto accept setting.

DeskPhoneNumber
  • Type: string

The phone number for the user's desk phone.

PhoneType
  • Required: Yes
  • Type: string

The phone type.

UserQuickConnectConfig

Description

Contains information about the quick connect configuration settings for a user. The contact flow must be of type Transfer to Agent.

Members
ContactFlowId
  • Required: Yes
  • Type: string

The identifier of the contact flow.

UserId
  • Required: Yes
  • Type: string

The identifier of the user.

UserSummary

Description

Contains summary information about a user.

Members
Arn
  • Type: string

The Amazon Resource Name (ARN) of the user account.

Id
  • Type: string

The identifier of the user account.

Username
  • Type: string

The Amazon Connect user name of the user account.

VoiceRecordingConfiguration

Description

Contains information about the recording configuration settings.

Members
VoiceRecordingTrack
  • Type: string

Identifies which track is being recorded.

AWS SDK for PHP 3.x API documentation generated by ApiGen