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
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • 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\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • 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\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • 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 Customer Profiles 2020-08-15

Client: Aws\CustomerProfiles\CustomerProfilesClient
Service ID: customer-profiles
Version: 2020-08-15

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

  • AddProfileKey ( array $params = [] )

    Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

  • CreateDomain ( array $params = [] )

    Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys.

  • CreateProfile ( array $params = [] )

    Creates a standard profile.

  • DeleteDomain ( array $params = [] )

    Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

  • DeleteIntegration ( array $params = [] )

    Removes an integration from a specific domain.

  • DeleteProfile ( array $params = [] )

    Deletes the standard customer profile and all data pertaining to the profile.

  • DeleteProfileKey ( array $params = [] )

    Removes a searchable key from a customer profile.

  • DeleteProfileObject ( array $params = [] )

    Removes an object associated with a profile of a given ProfileObjectType.

  • DeleteProfileObjectType ( array $params = [] )

    Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type.

  • GetDomain ( array $params = [] )

    Returns information about a specific domain.

  • GetIntegration ( array $params = [] )

    Returns an integration for a domain.

  • GetProfileObjectType ( array $params = [] )

    Returns the object types for a specific domain.

  • GetProfileObjectTypeTemplate ( array $params = [] )

    Returns the template information for a specific object type.

  • ListAccountIntegrations ( array $params = [] )

    Lists all of the integrations associated to a specific URI in the AWS account.

  • ListDomains ( array $params = [] )

    Returns a list of all the domains for an AWS account that have been created.

  • ListIntegrations ( array $params = [] )

    Lists all of the integrations in your domain.

  • ListProfileObjectTypeTemplates ( array $params = [] )

    Lists all of the template information for object types.

  • ListProfileObjectTypes ( array $params = [] )

    Lists all of the templates available within the service.

  • ListProfileObjects ( array $params = [] )

    Returns a list of objects associated with a profile of a given ProfileObjectType.

  • ListTagsForResource ( array $params = [] )

    Displays the tags associated with an Amazon Connect Customer Profiles resource.

  • PutIntegration ( array $params = [] )

    Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

  • PutProfileObject ( array $params = [] )

    Adds additional objects to customer profiles of a given ObjectType.

  • PutProfileObjectType ( array $params = [] )

    Defines a ProfileObjectType.

  • SearchProfiles ( array $params = [] )

    Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

  • TagResource ( array $params = [] )

    Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource.

  • UntagResource ( array $params = [] )

    Removes one or more tags from the specified Amazon Connect Customer Profiles resource.

  • UpdateDomain ( array $params = [] )

    Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

  • UpdateProfile ( array $params = [] )

    Updates the properties of a profile.

Operations

AddProfileKey

$result = $client->addProfileKey([/* ... */]);
$promise = $client->addProfileKeyAsync([/* ... */]);

Associates a new key value with a specific profile, such as a Contact Trace Record (CTR) ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Parameter Syntax

$result = $client->addProfileKey([
    'DomainName' => '<string>', // REQUIRED
    'KeyName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'Values' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

KeyName
  • Required: Yes
  • Type: string

A searchable identifier of a customer profile.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Values
  • Required: Yes
  • Type: Array of strings

A list of key values.

Result Syntax

[
    'KeyName' => '<string>',
    'Values' => ['<string>', ...],
]

Result Details

Members
KeyName
  • Type: string

A searchable identifier of a customer profile.

Values
  • Type: Array of strings

A list of key values.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Parameter Syntax

$result = $client->createDomain([
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>, // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
DeadLetterQueueUrl
  • Type: string

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

DefaultEncryptionKey
  • Type: string

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

DefaultExpirationDays
  • Required: Yes
  • Type: int

The default number of days until the data within the domain expires.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The tags used to organize, track, or control access for this resource.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

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

The timestamp of when the domain was created.

DeadLetterQueueUrl
  • Type: string

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

DefaultEncryptionKey
  • Type: string

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

DefaultExpirationDays
  • Required: Yes
  • Type: int

The default number of days until the data within the domain expires.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

Parameter Syntax

$result = $client->createProfile([
    'AccountNumber' => '<string>',
    'AdditionalInformation' => '<string>',
    'Address' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'BillingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'BirthDate' => '<string>',
    'BusinessEmailAddress' => '<string>',
    'BusinessName' => '<string>',
    'BusinessPhoneNumber' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'FirstName' => '<string>',
    'Gender' => 'MALE|FEMALE|UNSPECIFIED',
    'HomePhoneNumber' => '<string>',
    'LastName' => '<string>',
    'MailingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'MiddleName' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
    'PersonalEmailAddress' => '<string>',
    'PhoneNumber' => '<string>',
    'ShippingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
]);

Parameter Details

Members
AccountNumber
  • Type: string

A unique account number that you have given to the customer.

AdditionalInformation
  • Type: string

Any additional information relevant to the customer's profile.

Address
  • Type: Address structure

A generic address associated with the customer that is not mailing, shipping, or billing.

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

A key value pair of attributes of a customer profile.

BillingAddress
  • Type: Address structure

The customer’s billing address.

BirthDate
  • Type: string

The customer’s birth date.

BusinessEmailAddress
  • Type: string

The customer’s business email address.

BusinessName
  • Type: string

The name of the customer’s business.

BusinessPhoneNumber
  • Type: string

The customer’s business phone number.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

EmailAddress
  • Type: string

The customer's email address, which has not been specified as a personal or business address.

FirstName
  • Type: string

The customer’s first name.

Gender
  • Type: string

The gender with which the customer identifies.

HomePhoneNumber
  • Type: string

The customer’s home phone number.

LastName
  • Type: string

The customer’s last name.

MailingAddress
  • Type: Address structure

The customer’s mailing address.

MiddleName
  • Type: string

The customer’s middle name.

MobilePhoneNumber
  • Type: string

The customer’s mobile phone number.

PartyType
  • Type: string

The type of profile used to describe the customer.

PersonalEmailAddress
  • Type: string

The customer’s personal email address.

PhoneNumber
  • Type: string

The customer's phone number, which has not been specified as a mobile, home, or business number.

ShippingAddress
  • Type: Address structure

The customer’s shipping address.

Result Syntax

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

Result Details

Members
ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

Result Syntax

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

Result Details

Members
Message
  • Required: Yes
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Removes an integration from a specific domain.

Parameter Syntax

$result = $client->deleteIntegration([
    'DomainName' => '<string>', // REQUIRED
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Result Syntax

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

Result Details

Members
Message
  • Required: Yes
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

Deletes the standard customer profile and all data pertaining to the profile.

Parameter Syntax

$result = $client->deleteProfile([
    'DomainName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Result Syntax

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

Result Details

Members
Message
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteProfileKey

$result = $client->deleteProfileKey([/* ... */]);
$promise = $client->deleteProfileKeyAsync([/* ... */]);

Removes a searchable key from a customer profile.

Parameter Syntax

$result = $client->deleteProfileKey([
    'DomainName' => '<string>', // REQUIRED
    'KeyName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'Values' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

KeyName
  • Required: Yes
  • Type: string

A searchable identifier of a customer profile.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Values
  • Required: Yes
  • Type: Array of strings

A list of key values.

Result Syntax

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

Result Details

Members
Message
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteProfileObject

$result = $client->deleteProfileObject([/* ... */]);
$promise = $client->deleteProfileObjectAsync([/* ... */]);

Removes an object associated with a profile of a given ProfileObjectType.

Parameter Syntax

$result = $client->deleteProfileObject([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
    'ProfileObjectUniqueKey' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

ProfileObjectUniqueKey
  • Required: Yes
  • Type: string

The unique identifier of the profile object generated by the service.

Result Syntax

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

Result Details

Members
Message
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

DeleteProfileObjectType

$result = $client->deleteProfileObjectType([/* ... */]);
$promise = $client->deleteProfileObjectTypeAsync([/* ... */]);

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

Parameter Syntax

$result = $client->deleteProfileObjectType([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

Result Syntax

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

Result Details

Members
Message
  • Required: Yes
  • Type: string

A message that indicates the delete request is done.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

GetDomain

$result = $client->getDomain([/* ... */]);
$promise = $client->getDomainAsync([/* ... */]);

Returns information about a specific domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

A unique name for the domain.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Stats' => [
        'MeteringProfileCount' => <integer>,
        'ObjectCount' => <integer>,
        'ProfileCount' => <integer>,
        'TotalSize' => <integer>,
    ],
    'Tags' => ['<string>', ...],
]

Result Details

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

The timestamp of when the domain was created.

DeadLetterQueueUrl
  • Type: string

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

DefaultEncryptionKey
  • Type: string

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

DefaultExpirationDays
  • Type: int

The default number of days until the data within the domain expires.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

Stats
  • Type: DomainStats structure

Usage-specific statistics about the domain.

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

The tags used to organize, track, or control access for this resource.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Returns an integration for a domain.

Parameter Syntax

$result = $client->getIntegration([
    'DomainName' => '<string>', // REQUIRED
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'Tags' => ['<string>', ...],
    'Uri' => '<string>',
]

Result Details

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

The timestamp of when the domain was created.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

GetProfileObjectType

$result = $client->getProfileObjectType([/* ... */]);
$promise = $client->getProfileObjectTypeAsync([/* ... */]);

Returns the object types for a specific domain.

Parameter Syntax

$result = $client->getProfileObjectType([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]

Result Details

Members
AllowProfileCreation
  • Type: boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

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

The timestamp of when the domain was created.

Description
  • Required: Yes
  • Type: string

The description of the profile object type.

EncryptionKey
  • Type: string

The customer-provided key to encrypt the profile object that will be created in this profile object type.

ExpirationDays
  • Type: int

The number of days until the data in the object expires.

Fields
  • Type: Associative array of custom strings keys (name) to ObjectTypeField structures

A map of the name and ObjectType field.

Keys
  • Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress

A list of unique keys that can be used to map data to the profile.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

TemplateId
  • Type: string

A unique identifier for the object template.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

GetProfileObjectTypeTemplate

$result = $client->getProfileObjectTypeTemplate([/* ... */]);
$promise = $client->getProfileObjectTypeTemplateAsync([/* ... */]);

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

Parameter Syntax

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

Parameter Details

Members
TemplateId
  • Required: Yes
  • Type: string

A unique identifier for the object template.

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'SourceName' => '<string>',
    'SourceObject' => '<string>',
    'TemplateId' => '<string>',
]

Result Details

Members
AllowProfileCreation
  • Type: boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

Fields
  • Type: Associative array of custom strings keys (name) to ObjectTypeField structures

A map of the name and ObjectType field.

Keys
  • Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress

A list of unique keys that can be used to map data to the profile.

SourceName
  • Type: string

The name of the source of the object template.

SourceObject
  • Type: string

The source of the object template.

TemplateId
  • Type: string

A unique identifier for the object template.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListAccountIntegrations

$result = $client->listAccountIntegrations([/* ... */]);
$promise = $client->listAccountIntegrationsAsync([/* ... */]);

Lists all of the integrations associated to a specific URI in the AWS account.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous ListAccountIntegrations API call.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'Tags' => ['<string>', ...],
            'Uri' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListIntegrationItem structures

The list of ListAccountIntegration instances.

NextToken
  • Type: string

The pagination token from the previous ListAccountIntegrations API call.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Returns a list of all the domains for an AWS account that have been created.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous ListDomain API call.

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListDomainItem structures

The list of ListDomains instances.

NextToken
  • Type: string

The pagination token from the previous ListDomains API call.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListIntegrations

$result = $client->listIntegrations([/* ... */]);
$promise = $client->listIntegrationsAsync([/* ... */]);

Lists all of the integrations in your domain.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous ListIntegrations API call.

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainName' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'Tags' => ['<string>', ...],
            'Uri' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListIntegrationItem structures

The list of ListIntegrations instances.

NextToken
  • Type: string

The pagination token from the previous ListIntegrations API call.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListProfileObjectTypeTemplates

$result = $client->listProfileObjectTypeTemplates([/* ... */]);
$promise = $client->listProfileObjectTypeTemplatesAsync([/* ... */]);

Lists all of the template information for object types.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous ListObjectTypeTemplates API call.

Result Syntax

[
    'Items' => [
        [
            'SourceName' => '<string>',
            'SourceObject' => '<string>',
            'TemplateId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListProfileObjectTypeTemplateItem structures

The list of ListProfileObjectType template instances.

NextToken
  • Type: string

The pagination token from the previous ListObjectTypeTemplates API call.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListProfileObjectTypes

$result = $client->listProfileObjectTypes([/* ... */]);
$promise = $client->listProfileObjectTypesAsync([/* ... */]);

Lists all of the templates available within the service.

Parameter Syntax

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

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

Identifies the next page of results to return.

Result Syntax

[
    'Items' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'LastUpdatedAt' => <DateTime>,
            'ObjectTypeName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListProfileObjectTypeItem structures

The list of ListProfileObjectTypes instances.

NextToken
  • Type: string

Identifies the next page of results to return.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListProfileObjects

$result = $client->listProfileObjects([/* ... */]);
$promise = $client->listProfileObjectsAsync([/* ... */]);

Returns a list of objects associated with a profile of a given ProfileObjectType.

Parameter Syntax

$result = $client->listProfileObjects([
    'DomainName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ObjectTypeName' => '<string>', // REQUIRED
    'ProfileId' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous call to ListProfileObjects.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Result Syntax

[
    'Items' => [
        [
            'Object' => '<string>',
            'ObjectTypeName' => '<string>',
            'ProfileObjectUniqueKey' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of ListProfileObjectsItem structures

The list of ListProfileObject instances.

NextToken
  • Type: string

The pagination token from the previous call to ListProfileObjects.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

ListTagsForResource

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

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource for which you want to view tags.

Result Syntax

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

Result Details

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

The tags used to organize, track, or control access for this resource.

Errors

  • InternalServerException:

    An internal service error occurred.

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

PutIntegration

$result = $client->putIntegration([/* ... */]);
$promise = $client->putIntegrationAsync([/* ... */]);

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

Parameter Syntax

$result = $client->putIntegration([
    'DomainName' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Uri' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'Tags' => ['<string>', ...],
    'Uri' => '<string>',
]

Result Details

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

The timestamp of when the domain was created.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

PutProfileObject

$result = $client->putProfileObject([/* ... */]);
$promise = $client->putProfileObjectAsync([/* ... */]);

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Trace Record (CTR), an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional CTRs with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

Parameter Syntax

$result = $client->putProfileObject([
    'DomainName' => '<string>', // REQUIRED
    'Object' => '<string>', // REQUIRED
    'ObjectTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

Object
  • Required: Yes
  • Type: string

A string that is serialized from a JSON object.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

Result Syntax

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

Result Details

Members
ProfileObjectUniqueKey
  • Type: string

The unique identifier of the profile object generated by the service.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

PutProfileObjectType

$result = $client->putProfileObjectType([/* ... */]);
$promise = $client->putProfileObjectTypeAsync([/* ... */]);

Defines a ProfileObjectType.

Parameter Syntax

$result = $client->putProfileObjectType([
    'AllowProfileCreation' => true || false,
    'Description' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'ObjectTypeName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]);

Parameter Details

Members
AllowProfileCreation
  • Type: boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

Description
  • Required: Yes
  • Type: string

Description of the profile object type.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

EncryptionKey
  • Type: string

The customer-provided key to encrypt the profile object that will be created in this profile object type.

ExpirationDays
  • Type: int

The number of days until the data in the object expires.

Fields
  • Type: Associative array of custom strings keys (name) to ObjectTypeField structures

A map of the name and ObjectType field.

Keys
  • Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress

A list of unique keys that can be used to map data to the profile.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

TemplateId
  • Type: string

A unique identifier for the object template.

Result Syntax

[
    'AllowProfileCreation' => true || false,
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'EncryptionKey' => '<string>',
    'ExpirationDays' => <integer>,
    'Fields' => [
        '<name>' => [
            'ContentType' => 'STRING|NUMBER|PHONE_NUMBER|EMAIL_ADDRESS|NAME',
            'Source' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
    'Keys' => [
        '<name>' => [
            [
                'FieldNames' => ['<string>', ...],
                'StandardIdentifiers' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastUpdatedAt' => <DateTime>,
    'ObjectTypeName' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateId' => '<string>',
]

Result Details

Members
AllowProfileCreation
  • Type: boolean

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is FALSE. If the AllowProfileCreation flag is set to FALSE, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to TRUE, and if no match is found, then the service creates a new standard profile.

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

The timestamp of when the domain was created.

Description
  • Required: Yes
  • Type: string

Description of the profile object type.

EncryptionKey
  • Type: string

The customer-provided key to encrypt the profile object that will be created in this profile object type.

ExpirationDays
  • Type: int

The number of days until the data in the object expires.

Fields
  • Type: Associative array of custom strings keys (name) to ObjectTypeField structures

A map of the name and ObjectType field.

Keys
  • Type: Associative array of custom strings keys (name) to ObjectTypeKey structuress

A list of unique keys that can be used to map data to the profile.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

TemplateId
  • Type: string

A unique identifier for the object template.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

SearchProfiles

$result = $client->searchProfiles([/* ... */]);
$promise = $client->searchProfilesAsync([/* ... */]);

Searches for profiles within a specific domain name using name, phone number, email address, account number, or a custom defined index.

Parameter Syntax

$result = $client->searchProfiles([
    'DomainName' => '<string>', // REQUIRED
    'KeyName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Values' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

KeyName
  • Required: Yes
  • Type: string

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.

MaxResults
  • Type: int

The maximum number of objects returned per page.

NextToken
  • Type: string

The pagination token from the previous SearchProfiles API call.

Values
  • Required: Yes
  • Type: Array of strings

A list of key values.

Result Syntax

[
    'Items' => [
        [
            'AccountNumber' => '<string>',
            'AdditionalInformation' => '<string>',
            'Address' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'Attributes' => ['<string>', ...],
            'BillingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'BirthDate' => '<string>',
            'BusinessEmailAddress' => '<string>',
            'BusinessName' => '<string>',
            'BusinessPhoneNumber' => '<string>',
            'EmailAddress' => '<string>',
            'FirstName' => '<string>',
            'Gender' => 'MALE|FEMALE|UNSPECIFIED',
            'HomePhoneNumber' => '<string>',
            'LastName' => '<string>',
            'MailingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
            'MiddleName' => '<string>',
            'MobilePhoneNumber' => '<string>',
            'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
            'PersonalEmailAddress' => '<string>',
            'PhoneNumber' => '<string>',
            'ProfileId' => '<string>',
            'ShippingAddress' => [
                'Address1' => '<string>',
                'Address2' => '<string>',
                'Address3' => '<string>',
                'Address4' => '<string>',
                'City' => '<string>',
                'Country' => '<string>',
                'County' => '<string>',
                'PostalCode' => '<string>',
                'Province' => '<string>',
                'State' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Items
  • Type: Array of Profile structures

The list of SearchProfiles instances.

NextToken
  • Type: string

The pagination token from the previous SearchProfiles API call.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

TagResource

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

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource that you're adding tags to.

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

The tags used to organize, track, or control access for this resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal service error occurred.

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

UntagResource

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

Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource from which you are removing tags.

tagKeys
  • Required: Yes
  • Type: Array of strings

The list of tag keys to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An internal service error occurred.

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

UpdateDomain

$result = $client->updateDomain([/* ... */]);
$promise = $client->updateDomainAsync([/* ... */]);

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

Once a domain is created, the name can’t be changed.

Parameter Syntax

$result = $client->updateDomain([
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
DeadLetterQueueUrl
  • Type: string

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.

DefaultEncryptionKey
  • Type: string

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.

DefaultExpirationDays
  • Type: int

The default number of days until the data within the domain expires.

DomainName
  • Required: Yes
  • Type: string

The unique name for the domain.

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

The tags used to organize, track, or control access for this resource.

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DeadLetterQueueUrl' => '<string>',
    'DefaultEncryptionKey' => '<string>',
    'DefaultExpirationDays' => <integer>,
    'DomainName' => '<string>',
    'LastUpdatedAt' => <DateTime>,
    'Tags' => ['<string>', ...],
]

Result Details

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

The timestamp of when the domain was created.

DeadLetterQueueUrl
  • Type: string

The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.

DefaultEncryptionKey
  • Type: string

The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.

DefaultExpirationDays
  • Type: int

The default number of days until the data within the domain expires.

DomainName
  • Required: Yes
  • Type: string

The unique name for the domain.

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

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

UpdateProfile

$result = $client->updateProfile([/* ... */]);
$promise = $client->updateProfileAsync([/* ... */]);

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

Parameter Syntax

$result = $client->updateProfile([
    'AccountNumber' => '<string>',
    'AdditionalInformation' => '<string>',
    'Address' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'Attributes' => ['<string>', ...],
    'BillingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'BirthDate' => '<string>',
    'BusinessEmailAddress' => '<string>',
    'BusinessName' => '<string>',
    'BusinessPhoneNumber' => '<string>',
    'DomainName' => '<string>', // REQUIRED
    'EmailAddress' => '<string>',
    'FirstName' => '<string>',
    'Gender' => 'MALE|FEMALE|UNSPECIFIED',
    'HomePhoneNumber' => '<string>',
    'LastName' => '<string>',
    'MailingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
    'MiddleName' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'PartyType' => 'INDIVIDUAL|BUSINESS|OTHER',
    'PersonalEmailAddress' => '<string>',
    'PhoneNumber' => '<string>',
    'ProfileId' => '<string>', // REQUIRED
    'ShippingAddress' => [
        'Address1' => '<string>',
        'Address2' => '<string>',
        'Address3' => '<string>',
        'Address4' => '<string>',
        'City' => '<string>',
        'Country' => '<string>',
        'County' => '<string>',
        'PostalCode' => '<string>',
        'Province' => '<string>',
        'State' => '<string>',
    ],
]);

Parameter Details

Members
AccountNumber
  • Type: string

A unique account number that you have given to the customer.

AdditionalInformation
  • Type: string

Any additional information relevant to the customer's profile.

Address
  • Type: UpdateAddress structure

A generic address associated with the customer that is not mailing, shipping, or billing.

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

A key value pair of attributes of a customer profile.

BillingAddress
  • Type: UpdateAddress structure

The customer’s billing address.

BirthDate
  • Type: string

The customer’s birth date.

BusinessEmailAddress
  • Type: string

The customer’s business email address.

BusinessName
  • Type: string

The name of the customer’s business.

BusinessPhoneNumber
  • Type: string

The customer’s business phone number.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

EmailAddress
  • Type: string

The customer's email address, which has not been specified as a personal or business address.

FirstName
  • Type: string

The customer’s first name.

Gender
  • Type: string

The gender with which the customer identifies.

HomePhoneNumber
  • Type: string

The customer’s home phone number.

LastName
  • Type: string

The customer’s last name.

MailingAddress
  • Type: UpdateAddress structure

The customer’s mailing address.

MiddleName
  • Type: string

The customer’s middle name.

MobilePhoneNumber
  • Type: string

The customer’s mobile phone number.

PartyType
  • Type: string

The type of profile used to describe the customer.

PersonalEmailAddress
  • Type: string

The customer’s personal email address.

PhoneNumber
  • Type: string

The customer's phone number, which has not been specified as a mobile, home, or business number.

ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

ShippingAddress
  • Type: UpdateAddress structure

The customer’s shipping address.

Result Syntax

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

Result Details

Members
ProfileId
  • Required: Yes
  • Type: string

The unique identifier of a customer profile.

Errors

  • BadRequestException:

    The input you provided is invalid.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The requested resource does not exist, or access was denied.

  • ThrottlingException:

    You exceeded the maximum number of requests.

  • InternalServerException:

    An internal service error occurred.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
Message
  • Type: string

Address

Description

A generic address associated with the customer that is not mailing, shipping, or billing.

Members
Address1
  • Type: string

The first line of a customer address.

Address2
  • Type: string

The second line of a customer address.

Address3
  • Type: string

The third line of a customer address.

Address4
  • Type: string

The fourth line of a customer address.

City
  • Type: string

The city in which a customer lives.

Country
  • Type: string

The country in which a customer lives.

County
  • Type: string

The county in which a customer lives.

PostalCode
  • Type: string

The postal code of a customer address.

Province
  • Type: string

The province in which a customer lives.

State
  • Type: string

The state in which a customer lives.

BadRequestException

Description

The input you provided is invalid.

Members
Message
  • Type: string

DomainStats

Description

Usage-specific statistics about the domain.

Members
MeteringProfileCount
  • Type: long (int|float)

The number of profiles that you are currently paying for in the domain. If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.

ObjectCount
  • Type: long (int|float)

The total number of objects in domain.

ProfileCount
  • Type: long (int|float)

The total number of profiles currently in the domain.

TotalSize
  • Type: long (int|float)

The total size, in bytes, of all objects in the domain.

InternalServerException

Description

An internal service error occurred.

Members
Message
  • Type: string

ListDomainItem

Description

An object in a list that represents a domain.

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

The timestamp of when the domain was created.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

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

The tags used to organize, track, or control access for this resource.

ListIntegrationItem

Description

An integration in list of integrations.

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

The timestamp of when the domain was created.

DomainName
  • Required: Yes
  • Type: string

The unique name of the domain.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

Uri
  • Required: Yes
  • Type: string

The URI of the S3 bucket or any other type of data source.

ListProfileObjectTypeItem

Description

A ProfileObjectType instance.

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

The timestamp of when the domain was created.

Description
  • Required: Yes
  • Type: string

Description of the profile object type.

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

The timestamp of when the domain was most recently edited.

ObjectTypeName
  • Required: Yes
  • Type: string

The name of the profile object type.

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

The tags used to organize, track, or control access for this resource.

ListProfileObjectTypeTemplateItem

Description

A ProfileObjectTypeTemplate in a list of ProfileObjectTypeTemplates.

Members
SourceName
  • Type: string

The name of the source of the object template.

SourceObject
  • Type: string

The source of the object template.

TemplateId
  • Type: string

A unique identifier for the object template.

ListProfileObjectsItem

Description

A ProfileObject in a list of ProfileObjects.

Members
Object
  • Type: string

A JSON representation of a ProfileObject that belongs to a profile.

ObjectTypeName
  • Type: string

Specifies the kind of object being added to a profile, such as "Salesforce-Account."

ProfileObjectUniqueKey
  • Type: string

The unique identifier of the ProfileObject generated by the service.

ObjectTypeField

Description

Represents a field in a ProfileObjectType.

Members
ContentType
  • Type: string

The content type of the field. Used for determining equality when searching.

Source
  • Type: string

A field of a ProfileObject. For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.

Target
  • Type: string

The location of the data in the standard ProfileObject model. For example: _profile.Address.PostalCode.

ObjectTypeKey

Description

An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.

Members
FieldNames
  • Type: Array of strings

The reference for the key name of the fields map.

StandardIdentifiers
  • Type: Array of strings

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

Profile

Description

The standard profile of a customer.

Members
AccountNumber
  • Type: string

A unique account number that you have given to the customer.

AdditionalInformation
  • Type: string

Any additional information relevant to the customer's profile.

Address
  • Type: Address structure

A generic address associated with the customer that is not mailing, shipping, or billing.

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

A key value pair of attributes of a customer profile.

BillingAddress
  • Type: Address structure

The customer’s billing address.

BirthDate
  • Type: string

The customer’s birth date.

BusinessEmailAddress
  • Type: string

The customer’s business email address.

BusinessName
  • Type: string

The name of the customer’s business.

BusinessPhoneNumber
  • Type: string

The customer’s home phone number.

EmailAddress
  • Type: string

The customer's email address, which has not been specified as a personal or business address.

FirstName
  • Type: string

The customer’s first name.

Gender
  • Type: string

The gender with which the customer identifies.

HomePhoneNumber
  • Type: string

The customer’s home phone number.

LastName
  • Type: string

The customer’s last name.

MailingAddress
  • Type: Address structure

The customer’s mailing address.

MiddleName
  • Type: string

The customer’s middle name.

MobilePhoneNumber
  • Type: string

The customer’s mobile phone number.

PartyType
  • Type: string

The type of profile used to describe the customer.

PersonalEmailAddress
  • Type: string

The customer’s personal email address.

PhoneNumber
  • Type: string

The customer's phone number, which has not been specified as a mobile, home, or business number.

ProfileId
  • Type: string

The unique identifier of a customer profile.

ShippingAddress
  • Type: Address structure

The customer’s shipping address.

ResourceNotFoundException

Description

The requested resource does not exist, or access was denied.

Members
Message
  • Type: string

ThrottlingException

Description

You exceeded the maximum number of requests.

Members
Message
  • Type: string

UpdateAddress

Description

Updates associated with the address properties of a customer profile.

Members
Address1
  • Type: string

The first line of a customer address.

Address2
  • Type: string

The second line of a customer address.

Address3
  • Type: string

The third line of a customer address.

Address4
  • Type: string

The fourth line of a customer address.

City
  • Type: string

The city in which a customer lives.

Country
  • Type: string

The country in which a customer lives.

County
  • Type: string

The county in which a customer lives.

PostalCode
  • Type: string

The postal code of a customer address.

Province
  • Type: string

The province in which a customer lives.

State
  • Type: string

The state in which a customer lives.

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