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
    • FIS
      • 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
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • 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
    • mgn
      • 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\FIS\FISClient
  • 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\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • 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\mgn\mgnClient
  • 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\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\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\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • 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\mgn\Exception\mgnException
  • 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 Personalize 2018-05-22

Client: Aws\Personalize\PersonalizeClient
Service ID: personalize
Version: 2018-05-22

This page describes the parameters and results for the operations of the Amazon Personalize (2018-05-22), and shows how to use the Aws\Personalize\PersonalizeClient object to call the described operations. This documentation is specific to the 2018-05-22 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 */).

  • CreateBatchInferenceJob ( array $params = [] )

    Creates a batch inference job.

  • CreateCampaign ( array $params = [] )

    Creates a campaign by deploying a solution version.

  • CreateDataset ( array $params = [] )

    Creates an empty dataset and adds it to the specified dataset group.

  • CreateDatasetGroup ( array $params = [] )

    Creates an empty dataset group.

  • CreateDatasetImportJob ( array $params = [] )

    Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.

  • CreateEventTracker ( array $params = [] )

    Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

  • CreateFilter ( array $params = [] )

    Creates a recommendation filter.

  • CreateSchema ( array $params = [] )

    Creates an Amazon Personalize schema from the specified schema string.

  • CreateSolution ( array $params = [] )

    Creates the configuration for training a model.

  • CreateSolutionVersion ( array $params = [] )

    Trains or retrains an active solution.

  • DeleteCampaign ( array $params = [] )

    Removes a campaign by deleting the solution deployment.

  • DeleteDataset ( array $params = [] )

    Deletes a dataset.

  • DeleteDatasetGroup ( array $params = [] )

    Deletes a dataset group.

  • DeleteEventTracker ( array $params = [] )

    Deletes the event tracker.

  • DeleteFilter ( array $params = [] )

    Deletes a filter.

  • DeleteSchema ( array $params = [] )

    Deletes a schema.

  • DeleteSolution ( array $params = [] )

    Deletes all versions of a solution and the Solution object itself.

  • DescribeAlgorithm ( array $params = [] )

    Describes the given algorithm.

  • DescribeBatchInferenceJob ( array $params = [] )

    Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

  • DescribeCampaign ( array $params = [] )

    Describes the given campaign, including its status.

  • DescribeDataset ( array $params = [] )

    Describes the given dataset.

  • DescribeDatasetGroup ( array $params = [] )

    Describes the given dataset group.

  • DescribeDatasetImportJob ( array $params = [] )

    Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

  • DescribeEventTracker ( array $params = [] )

    Describes an event tracker.

  • DescribeFeatureTransformation ( array $params = [] )

    Describes the given feature transformation.

  • DescribeFilter ( array $params = [] )

    Describes a filter's properties.

  • DescribeRecipe ( array $params = [] )

    Describes a recipe.

  • DescribeSchema ( array $params = [] )

    Describes a schema.

  • DescribeSolution ( array $params = [] )

    Describes a solution.

  • DescribeSolutionVersion ( array $params = [] )

    Describes a specific version of a solution.

  • GetSolutionMetrics ( array $params = [] )

    Gets the metrics for the specified solution version.

  • ListBatchInferenceJobs ( array $params = [] )

    Gets a list of the batch inference jobs that have been performed off of a solution version.

  • ListCampaigns ( array $params = [] )

    Returns a list of campaigns that use the given solution.

  • ListDatasetGroups ( array $params = [] )

    Returns a list of dataset groups.

  • ListDatasetImportJobs ( array $params = [] )

    Returns a list of dataset import jobs that use the given dataset.

  • ListDatasets ( array $params = [] )

    Returns the list of datasets contained in the given dataset group.

  • ListEventTrackers ( array $params = [] )

    Returns the list of event trackers associated with the account.

  • ListFilters ( array $params = [] )

    Lists all filters that belong to a given dataset group.

  • ListRecipes ( array $params = [] )

    Returns a list of available recipes.

  • ListSchemas ( array $params = [] )

    Returns the list of schemas associated with the account.

  • ListSolutionVersions ( array $params = [] )

    Returns a list of solution versions for the given solution.

  • ListSolutions ( array $params = [] )

    Returns a list of solutions that use the given dataset group.

  • UpdateCampaign ( array $params = [] )

    Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

Paginators

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

  • ListBatchInferenceJobs
  • ListCampaigns
  • ListDatasetGroups
  • ListDatasetImportJobs
  • ListDatasets
  • ListEventTrackers
  • ListRecipes
  • ListSchemas
  • ListSolutionVersions
  • ListSolutions

Operations

CreateBatchInferenceJob

$result = $client->createBatchInferenceJob([/* ... */]);
$promise = $client->createBatchInferenceJobAsync([/* ... */]);

Creates a batch inference job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.

Parameter Syntax

$result = $client->createBatchInferenceJob([
    'batchInferenceJobConfig' => [
        'itemExplorationConfig' => ['<string>', ...],
    ],
    'filterArn' => '<string>',
    'jobInput' => [ // REQUIRED
        's3DataSource' => [ // REQUIRED
            'kmsKeyArn' => '<string>',
            'path' => '<string>', // REQUIRED
        ],
    ],
    'jobName' => '<string>', // REQUIRED
    'jobOutput' => [ // REQUIRED
        's3DataDestination' => [ // REQUIRED
            'kmsKeyArn' => '<string>',
            'path' => '<string>', // REQUIRED
        ],
    ],
    'numResults' => <integer>,
    'roleArn' => '<string>', // REQUIRED
    'solutionVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
batchInferenceJobConfig
  • Type: BatchInferenceJobConfig structure

The configuration details of a batch inference job.

filterArn
  • Type: string

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Using Filters with Amazon Personalize.

jobInput
  • Required: Yes
  • Type: BatchInferenceJobInput structure

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

jobName
  • Required: Yes
  • Type: string

The name of the batch inference job to create.

jobOutput
  • Required: Yes
  • Type: BatchInferenceJobOutput structure

The path to the Amazon S3 bucket where the job's output will be stored.

numResults
  • Type: int

The number of recommendations to retreive.

roleArn
  • Required: Yes
  • Type: string

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and out Amazon S3 buckets respectively.

solutionVersionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

Result Syntax

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

Result Details

Members
batchInferenceJobArn
  • Type: string

The ARN of the batch inference job.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

CreateCampaign

$result = $client->createCampaign([/* ... */]);
$promise = $client->createCampaignAsync([/* ... */]);

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge.

If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS. There's a short time delay while the capacity is increased that might cause loss of transactions.

The actual TPS used is calculated as the average requests/second within a 5-minute window. You pay for maximum of either the minimum provisioned TPS or the actual TPS. We recommend starting with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

  • ListCampaigns

  • DescribeCampaign

  • UpdateCampaign

  • DeleteCampaign

Parameter Syntax

$result = $client->createCampaign([
    'campaignConfig' => [
        'itemExplorationConfig' => ['<string>', ...],
    ],
    'minProvisionedTPS' => <integer>, // REQUIRED
    'name' => '<string>', // REQUIRED
    'solutionVersionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
campaignConfig
  • Type: CampaignConfig structure

The configuration details of a campaign.

minProvisionedTPS
  • Required: Yes
  • Type: int

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

name
  • Required: Yes
  • Type: string

A name for the new campaign. The campaign name must be unique within your account.

solutionVersionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution version to deploy.

Result Syntax

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

Result Details

Members
campaignArn
  • Type: string

The Amazon Resource Name (ARN) of the campaign.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

  • CreateDatasetGroup

  • ListDatasets

  • DescribeDataset

  • DeleteDataset

Parameter Syntax

$result = $client->createDataset([
    'datasetGroupArn' => '<string>', // REQUIRED
    'datasetType' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'schemaArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

datasetType
  • Required: Yes
  • Type: string

The type of dataset.

One of the following (case insensitive) values:

  • Interactions

  • Items

  • Users

name
  • Required: Yes
  • Type: string

The name for the dataset.

schemaArn
  • Required: Yes
  • Type: string

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

Result Syntax

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

Result Details

Members
datasetArn
  • Type: string

The ARN of the dataset.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

CreateDatasetGroup

$result = $client->createDatasetGroup([/* ... */]);
$promise = $client->createDatasetGroupAsync([/* ... */]);

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

  • CreateDataset

  • CreateEventTracker

  • CreateSolution

Related APIs

  • ListDatasetGroups

  • DescribeDatasetGroup

  • DeleteDatasetGroup

Parameter Syntax

$result = $client->createDatasetGroup([
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Members
kmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

name
  • Required: Yes
  • Type: string

The name for the new dataset group.

roleArn
  • Type: string

The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.

Result Syntax

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

Result Details

Members
datasetGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the new dataset group.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

CreateDatasetImportJob

$result = $client->createDatasetImportJob([/* ... */]);
$promise = $client->createDatasetImportJobAsync([/* ... */]);

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system.

The dataset import job replaces any existing data in the dataset that you imported in bulk.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

  • ListDatasetImportJobs

  • DescribeDatasetImportJob

Parameter Syntax

$result = $client->createDatasetImportJob([
    'dataSource' => [ // REQUIRED
        'dataLocation' => '<string>',
    ],
    'datasetArn' => '<string>', // REQUIRED
    'jobName' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
dataSource
  • Required: Yes
  • Type: DataSource structure

The Amazon S3 bucket that contains the training data to import.

datasetArn
  • Required: Yes
  • Type: string

The ARN of the dataset that receives the imported data.

jobName
  • Required: Yes
  • Type: string

The name for the dataset import job.

roleArn
  • Required: Yes
  • Type: string

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

Result Syntax

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

Result Details

Members
datasetImportJobArn
  • Type: string

The ARN of the dataset import job.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

CreateEventTracker

$result = $client->createEventTracker([/* ... */]);
$promise = $client->createEventTrackerAsync([/* ... */]);

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents API.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you create an event tracker, the response includes a tracking ID, which you pass as a parameter when you use the PutEvents operation. Amazon Personalize then appends the event data to the Interactions dataset of the dataset group you specify in your event tracker.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

  • ListEventTrackers

  • DescribeEventTracker

  • DeleteEventTracker

Parameter Syntax

$result = $client->createEventTracker([
    'datasetGroupArn' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

name
  • Required: Yes
  • Type: string

The name for the event tracker.

Result Syntax

[
    'eventTrackerArn' => '<string>',
    'trackingId' => '<string>',
]

Result Details

Members
eventTrackerArn
  • Type: string

The ARN of the event tracker.

trackingId
  • Type: string

The ID of the event tracker. Include this ID in requests to the PutEvents API.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

CreateFilter

$result = $client->createFilter([/* ... */]);
$promise = $client->createFilterAsync([/* ... */]);

Creates a recommendation filter. For more information, see filter.

Parameter Syntax

$result = $client->createFilter([
    'datasetGroupArn' => '<string>', // REQUIRED
    'filterExpression' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The ARN of the dataset group that the filter will belong to.

filterExpression
  • Required: Yes
  • Type: string

The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

name
  • Required: Yes
  • Type: string

The name of the filter to create.

Result Syntax

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

Result Details

Members
filterArn
  • Type: string

The ARN of the new filter.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

CreateSchema

$result = $client->createSchema([/* ... */]);
$promise = $client->createSchemaAsync([/* ... */]);

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

  • ListSchemas

  • DescribeSchema

  • DeleteSchema

Parameter Syntax

$result = $client->createSchema([
    'name' => '<string>', // REQUIRED
    'schema' => '<string>', // REQUIRED
]);

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name for the schema.

schema
  • Required: Yes
  • Type: string

A schema in Avro JSON format.

Result Syntax

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

Result Details

Members
schemaArn
  • Type: string

The Amazon Resource Name (ARN) of the created schema.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

CreateSolution

$result = $client->createSolution([/* ... */]);
$promise = $client->createSolutionAsync([/* ... */]);

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Amazon Personalize doesn't support configuring the hpoObjective for solution hyperparameter optimization at this time.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

  • ListSolutions

  • CreateSolutionVersion

  • DescribeSolution

  • DeleteSolution

  • ListSolutionVersions

  • DescribeSolutionVersion

Parameter Syntax

$result = $client->createSolution([
    'datasetGroupArn' => '<string>', // REQUIRED
    'eventType' => '<string>',
    'name' => '<string>', // REQUIRED
    'performAutoML' => true || false,
    'performHPO' => true || false,
    'recipeArn' => '<string>',
    'solutionConfig' => [
        'algorithmHyperParameters' => ['<string>', ...],
        'autoMLConfig' => [
            'metricName' => '<string>',
            'recipeList' => ['<string>', ...],
        ],
        'eventValueThreshold' => '<string>',
        'featureTransformationParameters' => ['<string>', ...],
        'hpoConfig' => [
            'algorithmHyperParameterRanges' => [
                'categoricalHyperParameterRanges' => [
                    [
                        'name' => '<string>',
                        'values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'continuousHyperParameterRanges' => [
                    [
                        'maxValue' => <float>,
                        'minValue' => <float>,
                        'name' => '<string>',
                    ],
                    // ...
                ],
                'integerHyperParameterRanges' => [
                    [
                        'maxValue' => <integer>,
                        'minValue' => <integer>,
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'hpoObjective' => [
                'metricName' => '<string>',
                'metricRegex' => '<string>',
                'type' => '<string>',
            ],
            'hpoResourceConfig' => [
                'maxNumberOfTrainingJobs' => '<string>',
                'maxParallelTrainingJobs' => '<string>',
            ],
        ],
    ],
]);

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

eventType
  • Type: string

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

If you do not provide an eventType, Amazon Personalize will use all interactions for training with equal weight regardless of type.

name
  • Required: Yes
  • Type: string

The name for the solution.

performAutoML
  • Type: boolean

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

performHPO
  • Type: boolean

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

recipeArn
  • Type: string

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

solutionConfig
  • Type: SolutionConfig structure

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Result Syntax

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

Result Details

Members
solutionArn
  • Type: string

The ARN of the solution.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceAlreadyExistsException:

    The specified resource already exists.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

CreateSolutionVersion

$result = $client->createSolutionVersion([/* ... */]);
$promise = $client->createSolutionVersionAsync([/* ... */]);

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

  • ListSolutionVersions

  • DescribeSolutionVersion

  • ListSolutions

  • CreateSolution

  • DescribeSolution

  • DeleteSolution

Parameter Syntax

$result = $client->createSolutionVersion([
    'solutionArn' => '<string>', // REQUIRED
    'trainingMode' => 'FULL|UPDATE',
]);

Parameter Details

Members
solutionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

trainingMode
  • Type: string

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

Result Syntax

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

Result Details

Members
solutionVersionArn
  • Type: string

The ARN of the new solution version.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • LimitExceededException:

    The limit on the number of requests per second has been exceeded.

  • ResourceInUseException:

    The specified resource is in use.

DeleteCampaign

$result = $client->deleteCampaign([/* ... */]);
$promise = $client->deleteCampaignAsync([/* ... */]);

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

Parameter Syntax

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

Parameter Details

Members
campaignArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the campaign to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

Parameter Syntax

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

Parameter Details

Members
datasetArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteDatasetGroup

$result = $client->deleteDatasetGroup([/* ... */]);
$promise = $client->deleteDatasetGroupAsync([/* ... */]);

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

Parameter Syntax

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

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The ARN of the dataset group to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteEventTracker

$result = $client->deleteEventTracker([/* ... */]);
$promise = $client->deleteEventTrackerAsync([/* ... */]);

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

Parameter Syntax

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

Parameter Details

Members
eventTrackerArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the event tracker to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteFilter

$result = $client->deleteFilter([/* ... */]);
$promise = $client->deleteFilterAsync([/* ... */]);

Deletes a filter.

Parameter Syntax

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

Parameter Details

Members
filterArn
  • Required: Yes
  • Type: string

The ARN of the filter to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteSchema

$result = $client->deleteSchema([/* ... */]);
$promise = $client->deleteSchemaAsync([/* ... */]);

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

Parameter Syntax

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

Parameter Details

Members
schemaArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the schema to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DeleteSolution

$result = $client->deleteSolution([/* ... */]);
$promise = $client->deleteSolutionAsync([/* ... */]);

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

Parameter Syntax

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

Parameter Details

Members
solutionArn
  • Required: Yes
  • Type: string

The ARN of the solution to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

DescribeAlgorithm

$result = $client->describeAlgorithm([/* ... */]);
$promise = $client->describeAlgorithmAsync([/* ... */]);

Describes the given algorithm.

Parameter Syntax

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

Parameter Details

Members
algorithmArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the algorithm to describe.

Result Syntax

[
    'algorithm' => [
        'algorithmArn' => '<string>',
        'algorithmImage' => [
            'dockerURI' => '<string>',
            'name' => '<string>',
        ],
        'creationDateTime' => <DateTime>,
        'defaultHyperParameterRanges' => [
            'categoricalHyperParameterRanges' => [
                [
                    'isTunable' => true || false,
                    'name' => '<string>',
                    'values' => ['<string>', ...],
                ],
                // ...
            ],
            'continuousHyperParameterRanges' => [
                [
                    'isTunable' => true || false,
                    'maxValue' => <float>,
                    'minValue' => <float>,
                    'name' => '<string>',
                ],
                // ...
            ],
            'integerHyperParameterRanges' => [
                [
                    'isTunable' => true || false,
                    'maxValue' => <integer>,
                    'minValue' => <integer>,
                    'name' => '<string>',
                ],
                // ...
            ],
        ],
        'defaultHyperParameters' => ['<string>', ...],
        'defaultResourceConfig' => ['<string>', ...],
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'roleArn' => '<string>',
        'trainingInputMode' => '<string>',
    ],
]

Result Details

Members
algorithm
  • Type: Algorithm structure

A listing of the properties of the algorithm.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeBatchInferenceJob

$result = $client->describeBatchInferenceJob([/* ... */]);
$promise = $client->describeBatchInferenceJobAsync([/* ... */]);

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

Parameter Syntax

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

Parameter Details

Members
batchInferenceJobArn
  • Required: Yes
  • Type: string

The ARN of the batch inference job to describe.

Result Syntax

[
    'batchInferenceJob' => [
        'batchInferenceJobArn' => '<string>',
        'batchInferenceJobConfig' => [
            'itemExplorationConfig' => ['<string>', ...],
        ],
        'creationDateTime' => <DateTime>,
        'failureReason' => '<string>',
        'filterArn' => '<string>',
        'jobInput' => [
            's3DataSource' => [
                'kmsKeyArn' => '<string>',
                'path' => '<string>',
            ],
        ],
        'jobName' => '<string>',
        'jobOutput' => [
            's3DataDestination' => [
                'kmsKeyArn' => '<string>',
                'path' => '<string>',
            ],
        ],
        'lastUpdatedDateTime' => <DateTime>,
        'numResults' => <integer>,
        'roleArn' => '<string>',
        'solutionVersionArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
batchInferenceJob
  • Type: BatchInferenceJob structure

Information on the specified batch inference job.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeCampaign

$result = $client->describeCampaign([/* ... */]);
$promise = $client->describeCampaignAsync([/* ... */]);

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

Parameter Syntax

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

Parameter Details

Members
campaignArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the campaign.

Result Syntax

[
    'campaign' => [
        'campaignArn' => '<string>',
        'campaignConfig' => [
            'itemExplorationConfig' => ['<string>', ...],
        ],
        'creationDateTime' => <DateTime>,
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestCampaignUpdate' => [
            'campaignConfig' => [
                'itemExplorationConfig' => ['<string>', ...],
            ],
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'minProvisionedTPS' => <integer>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        'minProvisionedTPS' => <integer>,
        'name' => '<string>',
        'solutionVersionArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
campaign
  • Type: Campaign structure

The properties of the campaign.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

Describes the given dataset. For more information on datasets, see CreateDataset.

Parameter Syntax

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

Parameter Details

Members
datasetArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset to describe.

Result Syntax

[
    'dataset' => [
        'creationDateTime' => <DateTime>,
        'datasetArn' => '<string>',
        'datasetGroupArn' => '<string>',
        'datasetType' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'schemaArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
dataset
  • Type: Dataset structure

A listing of the dataset's properties.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeDatasetGroup

$result = $client->describeDatasetGroup([/* ... */]);
$promise = $client->describeDatasetGroupAsync([/* ... */]);

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

Parameter Syntax

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

Parameter Details

Members
datasetGroupArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset group to describe.

Result Syntax

[
    'datasetGroup' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'failureReason' => '<string>',
        'kmsKeyArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'roleArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
datasetGroup
  • Type: DatasetGroup structure

A listing of the dataset group's properties.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeDatasetImportJob

$result = $client->describeDatasetImportJob([/* ... */]);
$promise = $client->describeDatasetImportJobAsync([/* ... */]);

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

Parameter Syntax

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

Parameter Details

Members
datasetImportJobArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the dataset import job to describe.

Result Syntax

[
    'datasetImportJob' => [
        'creationDateTime' => <DateTime>,
        'dataSource' => [
            'dataLocation' => '<string>',
        ],
        'datasetArn' => '<string>',
        'datasetImportJobArn' => '<string>',
        'failureReason' => '<string>',
        'jobName' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'roleArn' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
datasetImportJob
  • Type: DatasetImportJob structure

Information about the dataset import job, including the status.

The status is one of the following values:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeEventTracker

$result = $client->describeEventTracker([/* ... */]);
$promise = $client->describeEventTrackerAsync([/* ... */]);

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

Parameter Syntax

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

Parameter Details

Members
eventTrackerArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the event tracker to describe.

Result Syntax

[
    'eventTracker' => [
        'accountId' => '<string>',
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventTrackerArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'status' => '<string>',
        'trackingId' => '<string>',
    ],
]

Result Details

Members
eventTracker
  • Type: EventTracker structure

An object that describes the event tracker.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeFeatureTransformation

$result = $client->describeFeatureTransformation([/* ... */]);
$promise = $client->describeFeatureTransformationAsync([/* ... */]);

Describes the given feature transformation.

Parameter Syntax

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

Parameter Details

Members
featureTransformationArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the feature transformation to describe.

Result Syntax

[
    'featureTransformation' => [
        'creationDateTime' => <DateTime>,
        'defaultParameters' => ['<string>', ...],
        'featureTransformationArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
featureTransformation
  • Type: FeatureTransformation structure

A listing of the FeatureTransformation properties.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeFilter

$result = $client->describeFilter([/* ... */]);
$promise = $client->describeFilterAsync([/* ... */]);

Describes a filter's properties.

Parameter Syntax

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

Parameter Details

Members
filterArn
  • Required: Yes
  • Type: string

The ARN of the filter to describe.

Result Syntax

[
    'filter' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'failureReason' => '<string>',
        'filterArn' => '<string>',
        'filterExpression' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
filter
  • Type: Filter structure

The filter's details.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeRecipe

$result = $client->describeRecipe([/* ... */]);
$promise = $client->describeRecipeAsync([/* ... */]);

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

Parameter Syntax

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

Parameter Details

Members
recipeArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the recipe to describe.

Result Syntax

[
    'recipe' => [
        'algorithmArn' => '<string>',
        'creationDateTime' => <DateTime>,
        'description' => '<string>',
        'featureTransformationArn' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'recipeArn' => '<string>',
        'recipeType' => '<string>',
        'status' => '<string>',
    ],
]

Result Details

Members
recipe
  • Type: Recipe structure

An object that describes the recipe.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeSchema

$result = $client->describeSchema([/* ... */]);
$promise = $client->describeSchemaAsync([/* ... */]);

Describes a schema. For more information on schemas, see CreateSchema.

Parameter Syntax

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

Parameter Details

Members
schemaArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the schema to retrieve.

Result Syntax

[
    'schema' => [
        'creationDateTime' => <DateTime>,
        'lastUpdatedDateTime' => <DateTime>,
        'name' => '<string>',
        'schema' => '<string>',
        'schemaArn' => '<string>',
    ],
]

Result Details

Members
schema
  • Type: DatasetSchema structure

The requested schema.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeSolution

$result = $client->describeSolution([/* ... */]);
$promise = $client->describeSolutionAsync([/* ... */]);

Describes a solution. For more information on solutions, see CreateSolution.

Parameter Syntax

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

Parameter Details

Members
solutionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution to describe.

Result Syntax

[
    'solution' => [
        'autoMLResult' => [
            'bestRecipeArn' => '<string>',
        ],
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventType' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'latestSolutionVersion' => [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        'name' => '<string>',
        'performAutoML' => true || false,
        'performHPO' => true || false,
        'recipeArn' => '<string>',
        'solutionArn' => '<string>',
        'solutionConfig' => [
            'algorithmHyperParameters' => ['<string>', ...],
            'autoMLConfig' => [
                'metricName' => '<string>',
                'recipeList' => ['<string>', ...],
            ],
            'eventValueThreshold' => '<string>',
            'featureTransformationParameters' => ['<string>', ...],
            'hpoConfig' => [
                'algorithmHyperParameterRanges' => [
                    'categoricalHyperParameterRanges' => [
                        [
                            'name' => '<string>',
                            'values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'continuousHyperParameterRanges' => [
                        [
                            'maxValue' => <float>,
                            'minValue' => <float>,
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'integerHyperParameterRanges' => [
                        [
                            'maxValue' => <integer>,
                            'minValue' => <integer>,
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'hpoObjective' => [
                    'metricName' => '<string>',
                    'metricRegex' => '<string>',
                    'type' => '<string>',
                ],
                'hpoResourceConfig' => [
                    'maxNumberOfTrainingJobs' => '<string>',
                    'maxParallelTrainingJobs' => '<string>',
                ],
            ],
        ],
        'status' => '<string>',
    ],
]

Result Details

Members
solution
  • Type: Solution structure

An object that describes the solution.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

DescribeSolutionVersion

$result = $client->describeSolutionVersion([/* ... */]);
$promise = $client->describeSolutionVersionAsync([/* ... */]);

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

Parameter Syntax

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

Parameter Details

Members
solutionVersionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution version.

Result Syntax

[
    'solutionVersion' => [
        'creationDateTime' => <DateTime>,
        'datasetGroupArn' => '<string>',
        'eventType' => '<string>',
        'failureReason' => '<string>',
        'lastUpdatedDateTime' => <DateTime>,
        'performAutoML' => true || false,
        'performHPO' => true || false,
        'recipeArn' => '<string>',
        'solutionArn' => '<string>',
        'solutionConfig' => [
            'algorithmHyperParameters' => ['<string>', ...],
            'autoMLConfig' => [
                'metricName' => '<string>',
                'recipeList' => ['<string>', ...],
            ],
            'eventValueThreshold' => '<string>',
            'featureTransformationParameters' => ['<string>', ...],
            'hpoConfig' => [
                'algorithmHyperParameterRanges' => [
                    'categoricalHyperParameterRanges' => [
                        [
                            'name' => '<string>',
                            'values' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'continuousHyperParameterRanges' => [
                        [
                            'maxValue' => <float>,
                            'minValue' => <float>,
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'integerHyperParameterRanges' => [
                        [
                            'maxValue' => <integer>,
                            'minValue' => <integer>,
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'hpoObjective' => [
                    'metricName' => '<string>',
                    'metricRegex' => '<string>',
                    'type' => '<string>',
                ],
                'hpoResourceConfig' => [
                    'maxNumberOfTrainingJobs' => '<string>',
                    'maxParallelTrainingJobs' => '<string>',
                ],
            ],
        ],
        'solutionVersionArn' => '<string>',
        'status' => '<string>',
        'trainingHours' => <float>,
        'trainingMode' => 'FULL|UPDATE',
        'tunedHPOParams' => [
            'algorithmHyperParameters' => ['<string>', ...],
        ],
    ],
]

Result Details

Members
solutionVersion
  • Type: SolutionVersion structure

The solution version.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

GetSolutionMetrics

$result = $client->getSolutionMetrics([/* ... */]);
$promise = $client->getSolutionMetricsAsync([/* ... */]);

Gets the metrics for the specified solution version.

Parameter Syntax

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

Parameter Details

Members
solutionVersionArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

Result Syntax

[
    'metrics' => [<float>, ...],
    'solutionVersionArn' => '<string>',
]

Result Details

Members
metrics
  • Type: Associative array of custom strings keys (MetricName) to doubles

The metrics for the solution version.

solutionVersionArn
  • Type: string

The same solution version ARN as specified in the request.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

ListBatchInferenceJobs

$result = $client->listBatchInferenceJobs([/* ... */]);
$promise = $client->listBatchInferenceJobsAsync([/* ... */]);

Gets a list of the batch inference jobs that have been performed off of a solution version.

Parameter Syntax

$result = $client->listBatchInferenceJobs([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'solutionVersionArn' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of batch inference job results to return in each page. The default value is 100.

nextToken
  • Type: string

The token to request the next page of results.

solutionVersionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

Result Syntax

[
    'batchInferenceJobs' => [
        [
            'batchInferenceJobArn' => '<string>',
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
batchInferenceJobs
  • Type: Array of BatchInferenceJobSummary structures

A list containing information on each job that is returned.

nextToken
  • Type: string

The token to use to retreive the next page of results. The value is null when there are no more results to return.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListCampaigns

$result = $client->listCampaigns([/* ... */]);
$promise = $client->listCampaignsAsync([/* ... */]);

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

Parameter Syntax

$result = $client->listCampaigns([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'solutionArn' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of campaigns to return.

nextToken
  • Type: string

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

solutionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

Result Syntax

[
    'campaigns' => [
        [
            'campaignArn' => '<string>',
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
campaigns
  • Type: Array of CampaignSummary structures

A list of the campaigns.

nextToken
  • Type: string

A token for getting the next set of campaigns (if they exist).

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListDatasetGroups

$result = $client->listDatasetGroups([/* ... */]);
$promise = $client->listDatasetGroupsAsync([/* ... */]);

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

Parameter Syntax

$result = $client->listDatasetGroups([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of dataset groups to return.

nextToken
  • Type: string

A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

Result Syntax

[
    'datasetGroups' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetGroupArn' => '<string>',
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
datasetGroups
  • Type: Array of DatasetGroupSummary structures

The list of your dataset groups.

nextToken
  • Type: string

A token for getting the next set of dataset groups (if they exist).

Errors

  • InvalidNextTokenException:

    The token is not valid.

ListDatasetImportJobs

$result = $client->listDatasetImportJobs([/* ... */]);
$promise = $client->listDatasetImportJobsAsync([/* ... */]);

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

Parameter Syntax

$result = $client->listDatasetImportJobs([
    'datasetArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
datasetArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

maxResults
  • Type: int

The maximum number of dataset import jobs to return.

nextToken
  • Type: string

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

Result Syntax

[
    'datasetImportJobs' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetImportJobArn' => '<string>',
            'failureReason' => '<string>',
            'jobName' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
datasetImportJobs
  • Type: Array of DatasetImportJobSummary structures

The list of dataset import jobs.

nextToken
  • Type: string

A token for getting the next set of dataset import jobs (if they exist).

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListDatasets

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

Parameter Syntax

$result = $client->listDatasets([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
datasetGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

maxResults
  • Type: int

The maximum number of datasets to return.

nextToken
  • Type: string

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

Result Syntax

[
    'datasets' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetArn' => '<string>',
            'datasetType' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
datasets
  • Type: Array of DatasetSummary structures

An array of Dataset objects. Each object provides metadata information.

nextToken
  • Type: string

A token for getting the next set of datasets (if they exist).

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListEventTrackers

$result = $client->listEventTrackers([/* ... */]);
$promise = $client->listEventTrackersAsync([/* ... */]);

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

Parameter Syntax

$result = $client->listEventTrackers([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
datasetGroupArn
  • Type: string

The ARN of a dataset group used to filter the response.

maxResults
  • Type: int

The maximum number of event trackers to return.

nextToken
  • Type: string

A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

Result Syntax

[
    'eventTrackers' => [
        [
            'creationDateTime' => <DateTime>,
            'eventTrackerArn' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
eventTrackers
  • Type: Array of EventTrackerSummary structures

A list of event trackers.

nextToken
  • Type: string

A token for getting the next set of event trackers (if they exist).

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListFilters

$result = $client->listFilters([/* ... */]);
$promise = $client->listFiltersAsync([/* ... */]);

Lists all filters that belong to a given dataset group.

Parameter Syntax

$result = $client->listFilters([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
datasetGroupArn
  • Type: string

The ARN of the dataset group that contains the filters.

maxResults
  • Type: int

The maximum number of filters to return.

nextToken
  • Type: string

A token returned from the previous call to ListFilters for getting the next set of filters (if they exist).

Result Syntax

[
    'Filters' => [
        [
            'creationDateTime' => <DateTime>,
            'datasetGroupArn' => '<string>',
            'failureReason' => '<string>',
            'filterArn' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
Filters
  • Type: Array of FilterSummary structures

A list of returned filters.

nextToken
  • Type: string

A token for getting the next set of filters (if they exist).

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

ListRecipes

$result = $client->listRecipes([/* ... */]);
$promise = $client->listRecipesAsync([/* ... */]);

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->listRecipes([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'recipeProvider' => 'SERVICE',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of recipes to return.

nextToken
  • Type: string

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

recipeProvider
  • Type: string

The default is SERVICE.

Result Syntax

[
    'nextToken' => '<string>',
    'recipes' => [
        [
            'creationDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'recipeArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token for getting the next set of recipes.

recipes
  • Type: Array of RecipeSummary structures

The list of available recipes.

Errors

  • InvalidNextTokenException:

    The token is not valid.

ListSchemas

$result = $client->listSchemas([/* ... */]);
$promise = $client->listSchemasAsync([/* ... */]);

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

Parameter Syntax

$result = $client->listSchemas([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of schemas to return.

nextToken
  • Type: string

A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

Result Syntax

[
    'nextToken' => '<string>',
    'schemas' => [
        [
            'creationDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'schemaArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token used to get the next set of schemas (if they exist).

schemas
  • Type: Array of DatasetSchemaSummary structures

A list of schemas.

Errors

  • InvalidNextTokenException:

    The token is not valid.

ListSolutionVersions

$result = $client->listSolutionVersions([/* ... */]);
$promise = $client->listSolutionVersionsAsync([/* ... */]);

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Parameter Syntax

$result = $client->listSolutionVersions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'solutionArn' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of solution versions to return.

nextToken
  • Type: string

A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

solutionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution.

Result Syntax

[
    'nextToken' => '<string>',
    'solutionVersions' => [
        [
            'creationDateTime' => <DateTime>,
            'failureReason' => '<string>',
            'lastUpdatedDateTime' => <DateTime>,
            'solutionVersionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token for getting the next set of solution versions (if they exist).

solutionVersions
  • Type: Array of SolutionVersionSummary structures

A list of solution versions describing the version properties.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • InvalidNextTokenException:

    The token is not valid.

ListSolutions

$result = $client->listSolutions([/* ... */]);
$promise = $client->listSolutionsAsync([/* ... */]);

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

Parameter Syntax

$result = $client->listSolutions([
    'datasetGroupArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
datasetGroupArn
  • Type: string

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

maxResults
  • Type: int

The maximum number of solutions to return.

nextToken
  • Type: string

A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

Result Syntax

[
    'nextToken' => '<string>',
    'solutions' => [
        [
            'creationDateTime' => <DateTime>,
            'lastUpdatedDateTime' => <DateTime>,
            'name' => '<string>',
            'solutionArn' => '<string>',
            'status' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

A token for getting the next set of solutions (if they exist).

solutions
  • Type: Array of SolutionSummary structures

A list of the current solutions.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • InvalidNextTokenException:

    The token is not valid.

UpdateCampaign

$result = $client->updateCampaign([/* ... */]);
$promise = $client->updateCampaignAsync([/* ... */]);

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

Parameter Syntax

$result = $client->updateCampaign([
    'campaignArn' => '<string>', // REQUIRED
    'campaignConfig' => [
        'itemExplorationConfig' => ['<string>', ...],
    ],
    'minProvisionedTPS' => <integer>,
    'solutionVersionArn' => '<string>',
]);

Parameter Details

Members
campaignArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the campaign.

campaignConfig
  • Type: CampaignConfig structure

The configuration details of a campaign.

minProvisionedTPS
  • Type: int

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

solutionVersionArn
  • Type: string

The ARN of a new solution version to deploy.

Result Syntax

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

Result Details

Members
campaignArn
  • Type: string

The same campaign ARN as given in the request.

Errors

  • InvalidInputException:

    Provide a valid value for the field or parameter.

  • ResourceNotFoundException:

    Could not find the specified resource.

  • ResourceInUseException:

    The specified resource is in use.

Shapes

Algorithm

Description

Describes a custom algorithm.

Members
algorithmArn
  • Type: string

The Amazon Resource Name (ARN) of the algorithm.

algorithmImage
  • Type: AlgorithmImage structure

The URI of the Docker container for the algorithm image.

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

The date and time (in Unix time) that the algorithm was created.

defaultHyperParameterRanges
  • Type: DefaultHyperParameterRanges structure

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

defaultHyperParameters
  • Type: Associative array of custom strings keys (ParameterName) to strings

Specifies the default hyperparameters.

defaultResourceConfig
  • Type: Associative array of custom strings keys (ParameterName) to strings

Specifies the default maximum number of training jobs and parallel training jobs.

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

The date and time (in Unix time) that the algorithm was last updated.

name
  • Type: string

The name of the algorithm.

roleArn
  • Type: string

The Amazon Resource Name (ARN) of the role.

trainingInputMode
  • Type: string

The training input mode.

AlgorithmImage

Description

Describes an algorithm image.

Members
dockerURI
  • Required: Yes
  • Type: string

The URI of the Docker container for the algorithm image.

name
  • Type: string

The name of the algorithm image.

AutoMLConfig

Description

When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.

Members
metricName
  • Type: string

The metric to optimize.

recipeList
  • Type: Array of strings

The list of candidate recipes.

AutoMLResult

Description

When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.

Members
bestRecipeArn
  • Type: string

The Amazon Resource Name (ARN) of the best recipe.

BatchInferenceJob

Description

Contains information on a batch inference job.

Members
batchInferenceJobArn
  • Type: string

The Amazon Resource Name (ARN) of the batch inference job.

batchInferenceJobConfig
  • Type: BatchInferenceJobConfig structure

A string to string map of the configuration details of a batch inference job.

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

The time at which the batch inference job was created.

failureReason
  • Type: string

If the batch inference job failed, the reason for the failure.

filterArn
  • Type: string

The ARN of the filter used on the batch inference job.

jobInput
  • Type: BatchInferenceJobInput structure

The Amazon S3 path that leads to the input data used to generate the batch inference job.

jobName
  • Type: string

The name of the batch inference job.

jobOutput
  • Type: BatchInferenceJobOutput structure

The Amazon S3 bucket that contains the output data generated by the batch inference job.

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

The time at which the batch inference job was last updated.

numResults
  • Type: int

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

roleArn
  • Type: string

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.

solutionVersionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

status
  • Type: string

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

BatchInferenceJobConfig

Description

The configuration details of a batch inference job.

Members
itemExplorationConfig
  • Type: Associative array of custom strings keys (ParameterName) to strings

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. See native-recipe-new-item-USER_PERSONALIZATION.

BatchInferenceJobInput

Description

The input configuration of a batch inference job.

Members
s3DataSource
  • Required: Yes
  • Type: S3DataConfig structure

The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region as the API endpoint you are calling.

BatchInferenceJobOutput

Description

The output configuration parameters of a batch inference job.

Members
s3DataDestination
  • Required: Yes
  • Type: S3DataConfig structure

Information on the Amazon S3 bucket in which the batch inference job's output is stored.

BatchInferenceJobSummary

Description

A truncated version of the BatchInferenceJob datatype. The ListBatchInferenceJobs operation returns a list of batch inference job summaries.

Members
batchInferenceJobArn
  • Type: string

The Amazon Resource Name (ARN) of the batch inference job.

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

The time at which the batch inference job was created.

failureReason
  • Type: string

If the batch inference job failed, the reason for the failure.

jobName
  • Type: string

The name of the batch inference job.

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

The time at which the batch inference job was last updated.

solutionVersionArn
  • Type: string

The ARN of the solution version used by the batch inference job.

status
  • Type: string

The status of the batch inference job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

Campaign

Description

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

Members
campaignArn
  • Type: string

The Amazon Resource Name (ARN) of the campaign.

campaignConfig
  • Type: CampaignConfig structure

The configuration details of a campaign.

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

The date and time (in Unix format) that the campaign was created.

failureReason
  • Type: string

If a campaign fails, the reason behind the failure.

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

The date and time (in Unix format) that the campaign was last updated.

latestCampaignUpdate
  • Type: CampaignUpdateSummary structure

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

minProvisionedTPS
  • Type: int

Specifies the requested minimum provisioned transactions (recommendations) per second.

name
  • Type: string

The name of the campaign.

solutionVersionArn
  • Type: string

The Amazon Resource Name (ARN) of a specific version of the solution.

status
  • Type: string

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

CampaignConfig

Description

The configuration details of a campaign.

Members
itemExplorationConfig
  • Type: Associative array of custom strings keys (ParameterName) to strings

A string to string map specifying the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your solution uses the User-Personalization recipe.

CampaignSummary

Description

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

Members
campaignArn
  • Type: string

The Amazon Resource Name (ARN) of the campaign.

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

The date and time (in Unix time) that the campaign was created.

failureReason
  • Type: string

If a campaign fails, the reason behind the failure.

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

The date and time (in Unix time) that the campaign was last updated.

name
  • Type: string

The name of the campaign.

status
  • Type: string

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

CampaignUpdateSummary

Description

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

Members
campaignConfig
  • Type: CampaignConfig structure

The configuration details of a campaign.

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

The date and time (in Unix time) that the campaign update was created.

failureReason
  • Type: string

If a campaign update fails, the reason behind the failure.

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

The date and time (in Unix time) that the campaign update was last updated.

minProvisionedTPS
  • Type: int

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

solutionVersionArn
  • Type: string

The Amazon Resource Name (ARN) of the deployed solution version.

status
  • Type: string

The status of the campaign update.

A campaign update can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

CategoricalHyperParameterRange

Description

Provides the name and range of a categorical hyperparameter.

Members
name
  • Type: string

The name of the hyperparameter.

values
  • Type: Array of strings

A list of the categories for the hyperparameter.

ContinuousHyperParameterRange

Description

Provides the name and range of a continuous hyperparameter.

Members
maxValue
  • Type: double

The maximum allowable value for the hyperparameter.

minValue
  • Type: double

The minimum allowable value for the hyperparameter.

name
  • Type: string

The name of the hyperparameter.

DataSource

Description

Describes the data source that contains the data to upload to a dataset.

Members
dataLocation
  • Type: string

The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

s3://bucket-name/training-data.csv

Dataset

Description

Provides metadata for a dataset.

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

The creation date and time (in Unix time) of the dataset.

datasetArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

datasetGroupArn
  • Type: string

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

datasetType
  • Type: string

One of the following values:

  • Interactions

  • Items

  • Users

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

A time stamp that shows when the dataset was updated.

name
  • Type: string

The name of the dataset.

schemaArn
  • Type: string

The ARN of the associated schema.

status
  • Type: string

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

DatasetGroup

Description

A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

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

The creation date and time (in Unix time) of the dataset group.

datasetGroupArn
  • Type: string

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

failureReason
  • Type: string

If creating a dataset group fails, provides the reason why.

kmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.

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

The last update date and time (in Unix time) of the dataset group.

name
  • Type: string

The name of the dataset group.

roleArn
  • Type: string

The ARN of the IAM role that has permissions to create the dataset group.

status
  • Type: string

The current status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

DatasetGroupSummary

Description

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

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

The date and time (in Unix time) that the dataset group was created.

datasetGroupArn
  • Type: string

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

failureReason
  • Type: string

If creating a dataset group fails, the reason behind the failure.

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

The date and time (in Unix time) that the dataset group was last updated.

name
  • Type: string

The name of the dataset group.

status
  • Type: string

The status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

DatasetImportJob

Description

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

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

The creation date and time (in Unix time) of the dataset import job.

dataSource
  • Type: DataSource structure

The Amazon S3 bucket that contains the training data to import.

datasetArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

datasetImportJobArn
  • Type: string

The ARN of the dataset import job.

failureReason
  • Type: string

If a dataset import job fails, provides the reason why.

jobName
  • Type: string

The name of the import job.

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

The date and time (in Unix time) the dataset was last updated.

roleArn
  • Type: string

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.

status
  • Type: string

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

DatasetImportJobSummary

Description

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

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

The date and time (in Unix time) that the dataset import job was created.

datasetImportJobArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset import job.

failureReason
  • Type: string

If a dataset import job fails, the reason behind the failure.

jobName
  • Type: string

The name of the dataset import job.

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

The date and time (in Unix time) that the dataset was last updated.

status
  • Type: string

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

DatasetSchema

Description

Describes the schema for a dataset. For more information on schemas, see CreateSchema.

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

The date and time (in Unix time) that the schema was created.

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

The date and time (in Unix time) that the schema was last updated.

name
  • Type: string

The name of the schema.

schema
  • Type: string

The schema.

schemaArn
  • Type: string

The Amazon Resource Name (ARN) of the schema.

DatasetSchemaSummary

Description

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

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

The date and time (in Unix time) that the schema was created.

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

The date and time (in Unix time) that the schema was last updated.

name
  • Type: string

The name of the schema.

schemaArn
  • Type: string

The Amazon Resource Name (ARN) of the schema.

DatasetSummary

Description

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

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

The date and time (in Unix time) that the dataset was created.

datasetArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset.

datasetType
  • Type: string

The dataset type. One of the following values:

  • Interactions

  • Items

  • Users

  • Event-Interactions

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

The date and time (in Unix time) that the dataset was last updated.

name
  • Type: string

The name of the dataset.

status
  • Type: string

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

DefaultCategoricalHyperParameterRange

Description

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Members
isTunable
  • Type: boolean

Whether the hyperparameter is tunable.

name
  • Type: string

The name of the hyperparameter.

values
  • Type: Array of strings

A list of the categories for the hyperparameter.

DefaultContinuousHyperParameterRange

Description

Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Members
isTunable
  • Type: boolean

Whether the hyperparameter is tunable.

maxValue
  • Type: double

The maximum allowable value for the hyperparameter.

minValue
  • Type: double

The minimum allowable value for the hyperparameter.

name
  • Type: string

The name of the hyperparameter.

DefaultHyperParameterRanges

Description

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

Members
categoricalHyperParameterRanges
  • Type: Array of DefaultCategoricalHyperParameterRange structures

The categorical hyperparameters and their default ranges.

continuousHyperParameterRanges
  • Type: Array of DefaultContinuousHyperParameterRange structures

The continuous hyperparameters and their default ranges.

integerHyperParameterRanges
  • Type: Array of DefaultIntegerHyperParameterRange structures

The integer-valued hyperparameters and their default ranges.

DefaultIntegerHyperParameterRange

Description

Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

Members
isTunable
  • Type: boolean

Indicates whether the hyperparameter is tunable.

maxValue
  • Type: int

The maximum allowable value for the hyperparameter.

minValue
  • Type: int

The minimum allowable value for the hyperparameter.

name
  • Type: string

The name of the hyperparameter.

EventTracker

Description

Provides information about an event tracker.

Members
accountId
  • Type: string

The Amazon AWS account that owns the event tracker.

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

The date and time (in Unix format) that the event tracker was created.

datasetGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

eventTrackerArn
  • Type: string

The ARN of the event tracker.

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

The date and time (in Unix time) that the event tracker was last updated.

name
  • Type: string

The name of the event tracker.

status
  • Type: string

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

trackingId
  • Type: string

The ID of the event tracker. Include this ID in requests to the PutEvents API.

EventTrackerSummary

Description

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

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

The date and time (in Unix time) that the event tracker was created.

eventTrackerArn
  • Type: string

The Amazon Resource Name (ARN) of the event tracker.

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

The date and time (in Unix time) that the event tracker was last updated.

name
  • Type: string

The name of the event tracker.

status
  • Type: string

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

FeatureTransformation

Description

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

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

The creation date and time (in Unix time) of the feature transformation.

defaultParameters
  • Type: Associative array of custom strings keys (ParameterName) to strings

Provides the default parameters for feature transformation.

featureTransformationArn
  • Type: string

The Amazon Resource Name (ARN) of the FeatureTransformation object.

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

The last update date and time (in Unix time) of the feature transformation.

name
  • Type: string

The name of the feature transformation.

status
  • Type: string

The status of the feature transformation.

A feature transformation can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

Filter

Description

Contains information on a recommendation filter, including its ARN, status, and filter expression.

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

The time at which the filter was created.

datasetGroupArn
  • Type: string

The ARN of the dataset group to which the filter belongs.

failureReason
  • Type: string

If the filter failed, the reason for its failure.

filterArn
  • Type: string

The ARN of the filter.

filterExpression
  • Type: string

Specifies the type of item interactions to filter out of recommendation results. The filter expression must follow specific format rules. For information about filter expression structure and syntax, see filter-expressions.

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

The time at which the filter was last updated.

name
  • Type: string

The name of the filter.

status
  • Type: string

The status of the filter.

FilterSummary

Description

A short summary of a filter's attributes.

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

The time at which the filter was created.

datasetGroupArn
  • Type: string

The ARN of the dataset group to which the filter belongs.

failureReason
  • Type: string

If the filter failed, the reason for the failure.

filterArn
  • Type: string

The ARN of the filter.

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

The time at which the filter was last updated.

name
  • Type: string

The name of the filter.

status
  • Type: string

The status of the filter.

HPOConfig

Description

Describes the properties for hyperparameter optimization (HPO).

Members
algorithmHyperParameterRanges
  • Type: HyperParameterRanges structure

The hyperparameters and their allowable ranges.

hpoObjective
  • Type: HPOObjective structure

The metric to optimize during HPO.

Amazon Personalize doesn't support configuring the hpoObjective at this time.

hpoResourceConfig
  • Type: HPOResourceConfig structure

Describes the resource configuration for HPO.

HPOObjective

Description

The metric to optimize during hyperparameter optimization (HPO).

Amazon Personalize doesn't support configuring the hpoObjective at this time.

Members
metricName
  • Type: string

The name of the metric.

metricRegex
  • Type: string

A regular expression for finding the metric in the training job logs.

type
  • Type: string

The type of the metric. Valid values are Maximize and Minimize.

HPOResourceConfig

Description

Describes the resource configuration for hyperparameter optimization (HPO).

Members
maxNumberOfTrainingJobs
  • Type: string

The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

maxParallelTrainingJobs
  • Type: string

The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

HyperParameterRanges

Description

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

Members
categoricalHyperParameterRanges
  • Type: Array of CategoricalHyperParameterRange structures

The categorical hyperparameters and their ranges.

continuousHyperParameterRanges
  • Type: Array of ContinuousHyperParameterRange structures

The continuous hyperparameters and their ranges.

integerHyperParameterRanges
  • Type: Array of IntegerHyperParameterRange structures

The integer-valued hyperparameters and their ranges.

IntegerHyperParameterRange

Description

Provides the name and range of an integer-valued hyperparameter.

Members
maxValue
  • Type: int

The maximum allowable value for the hyperparameter.

minValue
  • Type: int

The minimum allowable value for the hyperparameter.

name
  • Type: string

The name of the hyperparameter.

InvalidInputException

Description

Provide a valid value for the field or parameter.

Members
message
  • Type: string

InvalidNextTokenException

Description

The token is not valid.

Members
message
  • Type: string

LimitExceededException

Description

The limit on the number of requests per second has been exceeded.

Members
message
  • Type: string

Recipe

Description

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.

Members
algorithmArn
  • Type: string

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

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

The date and time (in Unix format) that the recipe was created.

description
  • Type: string

The description of the recipe.

featureTransformationArn
  • Type: string

The ARN of the FeatureTransformation object.

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

The date and time (in Unix format) that the recipe was last updated.

name
  • Type: string

The name of the recipe.

recipeArn
  • Type: string

The Amazon Resource Name (ARN) of the recipe.

recipeType
  • Type: string

One of the following values:

  • PERSONALIZED_RANKING

  • RELATED_ITEMS

  • USER_PERSONALIZATION

status
  • Type: string

The status of the recipe.

RecipeSummary

Description

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

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

The date and time (in Unix time) that the recipe was created.

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

The date and time (in Unix time) that the recipe was last updated.

name
  • Type: string

The name of the recipe.

recipeArn
  • Type: string

The Amazon Resource Name (ARN) of the recipe.

status
  • Type: string

The status of the recipe.

ResourceAlreadyExistsException

Description

The specified resource already exists.

Members
message
  • Type: string

ResourceInUseException

Description

The specified resource is in use.

Members
message
  • Type: string

ResourceNotFoundException

Description

Could not find the specified resource.

Members
message
  • Type: string

S3DataConfig

Description

The configuration details of an Amazon S3 input or output bucket.

Members
kmsKeyArn
  • Type: string

The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.

path
  • Required: Yes
  • Type: string

The file path of the Amazon S3 bucket.

Solution

Description

An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.

Members
autoMLResult
  • Type: AutoMLResult structure

When performAutoML is true, specifies the best recipe found.

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

The creation date and time (in Unix time) of the solution.

datasetGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

eventType
  • Type: string

The event type (for example, 'click' or 'like') that is used for training the model. If no eventType is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type.

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

The date and time (in Unix time) that the solution was last updated.

latestSolutionVersion
  • Type: SolutionVersionSummary structure

Describes the latest version of the solution, including the status and the ARN.

name
  • Type: string

The name of the solution.

performAutoML
  • Type: boolean

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

performHPO
  • Type: boolean

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

recipeArn
  • Type: string

The ARN of the recipe used to create the solution.

solutionArn
  • Type: string

The ARN of the solution.

solutionConfig
  • Type: SolutionConfig structure

Describes the configuration properties for the solution.

status
  • Type: string

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

SolutionConfig

Description

Describes the configuration properties for the solution.

Members
algorithmHyperParameters
  • Type: Associative array of custom strings keys (ParameterName) to strings

Lists the hyperparameter names and ranges.

autoMLConfig
  • Type: AutoMLConfig structure

The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

eventValueThreshold
  • Type: string

Only events with a value greater than or equal to this threshold are used for training a model.

featureTransformationParameters
  • Type: Associative array of custom strings keys (ParameterName) to strings

Lists the feature transformation parameters.

hpoConfig
  • Type: HPOConfig structure

Describes the properties for hyperparameter optimization (HPO).

SolutionSummary

Description

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.

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

The date and time (in Unix time) that the solution was created.

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

The date and time (in Unix time) that the solution was last updated.

name
  • Type: string

The name of the solution.

solutionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution.

status
  • Type: string

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

SolutionVersion

Description

An object that provides information about a specific version of a Solution.

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

The date and time (in Unix time) that this version of the solution was created.

datasetGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the dataset group providing the training data.

eventType
  • Type: string

The event type (for example, 'click' or 'like') that is used for training the model.

failureReason
  • Type: string

If training a solution version fails, the reason for the failure.

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

The date and time (in Unix time) that the solution was last updated.

performAutoML
  • Type: boolean

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

performHPO
  • Type: boolean

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

recipeArn
  • Type: string

The ARN of the recipe used in the solution.

solutionArn
  • Type: string

The ARN of the solution.

solutionConfig
  • Type: SolutionConfig structure

Describes the configuration properties for the solution.

solutionVersionArn
  • Type: string

The ARN of the solution version.

status
  • Type: string

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

trainingHours
  • Type: double

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

trainingMode
  • Type: string

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the User-Personalization recipe or the HRNN-Coldstart recipe.

tunedHPOParams
  • Type: TunedHPOParams structure

If hyperparameter optimization was performed, contains the hyperparameter values of the best performing model.

SolutionVersionSummary

Description

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

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

The date and time (in Unix time) that this version of a solution was created.

failureReason
  • Type: string

If a solution version fails, the reason behind the failure.

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

The date and time (in Unix time) that the solution version was last updated.

solutionVersionArn
  • Type: string

The Amazon Resource Name (ARN) of the solution version.

status
  • Type: string

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

TunedHPOParams

Description

If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.

Members
algorithmHyperParameters
  • Type: Associative array of custom strings keys (ParameterName) to strings

A list of the hyperparameter values of the best performing model.

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