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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

Amazon Fraud Detector 2019-11-15

Client: Aws\FraudDetector\FraudDetectorClient
Service ID: frauddetector
Version: 2019-11-15

This page describes the parameters and results for the operations of the Amazon Fraud Detector (2019-11-15), and shows how to use the Aws\FraudDetector\FraudDetectorClient object to call the described operations. This documentation is specific to the 2019-11-15 API version of the service.

Operation Summary

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

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

  • BatchCreateVariable ( array $params = [] )

    Creates a batch of variables.

  • BatchGetVariable ( array $params = [] )

    Gets a batch of variables.

  • CreateDetectorVersion ( array $params = [] )

    Creates a detector version.

  • CreateModel ( array $params = [] )

    Creates a model using the specified model type.

  • CreateModelVersion ( array $params = [] )

    Creates a version of the model using the specified model type and model id.

  • CreateRule ( array $params = [] )

    Creates a rule for use with the specified detector.

  • CreateVariable ( array $params = [] )

    Creates a variable.

  • DeleteDetector ( array $params = [] )

    Deletes the detector.

  • DeleteDetectorVersion ( array $params = [] )

    Deletes the detector version.

  • DeleteEntityType ( array $params = [] )

    Deletes an entity type.

  • DeleteEvent ( array $params = [] )

    Deletes the specified event.

  • DeleteEventType ( array $params = [] )

    Deletes an event type.

  • DeleteExternalModel ( array $params = [] )

    Removes a SageMaker model from Amazon Fraud Detector.

  • DeleteLabel ( array $params = [] )

    Deletes a label.

  • DeleteModel ( array $params = [] )

    Deletes a model.

  • DeleteModelVersion ( array $params = [] )

    Deletes a model version.

  • DeleteOutcome ( array $params = [] )

    Deletes an outcome.

  • DeleteRule ( array $params = [] )

    Deletes the rule.

  • DeleteVariable ( array $params = [] )

    Deletes a variable.

  • DescribeDetector ( array $params = [] )

    Gets all versions for a specified detector.

  • DescribeModelVersions ( array $params = [] )

    Gets all of the model versions for the specified model type or for the specified model type and model ID.

  • GetDetectorVersion ( array $params = [] )

    Gets a particular detector version.

  • GetDetectors ( array $params = [] )

    Gets all detectors or a single detector if a detectorId is specified.

  • GetEntityTypes ( array $params = [] )

    Gets all entity types or a specific entity type if a name is specified.

  • GetEventPrediction ( array $params = [] )

    Evaluates an event against a detector version.

  • GetEventTypes ( array $params = [] )

    Gets all event types or a specific event type if name is provided.

  • GetExternalModels ( array $params = [] )

    Gets the details for one or more Amazon SageMaker models that have been imported into the service.

  • GetKMSEncryptionKey ( array $params = [] )

    Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.

  • GetLabels ( array $params = [] )

    Gets all labels or a specific label if name is provided.

  • GetModelVersion ( array $params = [] )

    Gets the details of the specified model version.

  • GetModels ( array $params = [] )

    Gets one or more models.

  • GetOutcomes ( array $params = [] )

    Gets one or more outcomes.

  • GetRules ( array $params = [] )

    Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified.

  • GetVariables ( array $params = [] )

    Gets all of the variables or the specific variable.

  • ListTagsForResource ( array $params = [] )

    Lists all tags associated with the resource.

  • PutDetector ( array $params = [] )

    Creates or updates a detector.

  • PutEntityType ( array $params = [] )

    Creates or updates an entity type.

  • PutEventType ( array $params = [] )

    Creates or updates an event type.

  • PutExternalModel ( array $params = [] )

    Creates or updates an Amazon SageMaker model endpoint.

  • PutKMSEncryptionKey ( array $params = [] )

    Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

  • PutLabel ( array $params = [] )

    Creates or updates label.

  • PutOutcome ( array $params = [] )

    Creates or updates an outcome.

  • TagResource ( array $params = [] )

    Assigns tags to a resource.

  • UntagResource ( array $params = [] )

    Removes tags from a resource.

  • UpdateDetectorVersion ( array $params = [] )

    Updates a detector version.

  • UpdateDetectorVersionMetadata ( array $params = [] )

    Updates the detector version's description.

  • UpdateDetectorVersionStatus ( array $params = [] )

    Updates the detector version’s status.

  • UpdateModel ( array $params = [] )

    Updates a model.

  • UpdateModelVersion ( array $params = [] )

    Updates a model version.

  • UpdateModelVersionStatus ( array $params = [] )

    Updates the status of a model version.

  • UpdateRuleMetadata ( array $params = [] )

    Updates a rule's metadata.

  • UpdateRuleVersion ( array $params = [] )

    Updates a rule version resulting in a new rule version.

  • UpdateVariable ( array $params = [] )

    Updates a variable.

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:

  • DescribeModelVersions
  • GetDetectors
  • GetEntityTypes
  • GetEventTypes
  • GetExternalModels
  • GetLabels
  • GetModels
  • GetOutcomes
  • GetRules
  • GetVariables
  • ListTagsForResource

Operations

BatchCreateVariable

$result = $client->batchCreateVariable([/* ... */]);
$promise = $client->batchCreateVariableAsync([/* ... */]);

Creates a batch of variables.

Parameter Syntax

$result = $client->batchCreateVariable([
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'variableEntries' => [ // REQUIRED
        [
            'dataSource' => '<string>',
            'dataType' => '<string>',
            'defaultValue' => '<string>',
            'description' => '<string>',
            'name' => '<string>',
            'variableType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
tags
  • Type: Array of Tag structures

A collection of key and value pairs.

variableEntries
  • Required: Yes
  • Type: Array of VariableEntry structures

The list of variables for the batch create variable request.

Result Syntax

[
    'errors' => [
        [
            'code' => <integer>,
            'message' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
errors
  • Type: Array of BatchCreateVariableError structures

Provides the errors for the BatchCreateVariable request.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

BatchGetVariable

$result = $client->batchGetVariable([/* ... */]);
$promise = $client->batchGetVariableAsync([/* ... */]);

Gets a batch of variables.

Parameter Syntax

$result = $client->batchGetVariable([
    'names' => ['<string>', ...], // REQUIRED
]);

Parameter Details

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

The list of variable names to get.

Result Syntax

[
    'errors' => [
        [
            'code' => <integer>,
            'message' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'variables' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE',
            'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN',
            'defaultValue' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
            'variableType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
errors
  • Type: Array of BatchGetVariableError structures

The errors from the request.

variables
  • Type: Array of Variable structures

The returned variables.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CreateDetectorVersion

$result = $client->createDetectorVersion([/* ... */]);
$promise = $client->createDetectorVersionAsync([/* ... */]);

Creates a detector version. The detector version starts in a DRAFT status.

Parameter Syntax

$result = $client->createDetectorVersion([
    'description' => '<string>',
    'detectorId' => '<string>', // REQUIRED
    'externalModelEndpoints' => ['<string>', ...],
    'modelVersions' => [
        [
            'arn' => '<string>',
            'modelId' => '<string>', // REQUIRED
            'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
            'modelVersionNumber' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
    'rules' => [ // REQUIRED
        [
            'detectorId' => '<string>', // REQUIRED
            'ruleId' => '<string>', // REQUIRED
            'ruleVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The description of the detector version.

detectorId
  • Required: Yes
  • Type: string

The ID of the detector under which you want to create a new version.

externalModelEndpoints
  • Type: Array of strings

The Amazon Sagemaker model endpoints to include in the detector version.

modelVersions
  • Type: Array of ModelVersion structures

The model versions to include in the detector version.

ruleExecutionMode
  • Type: string

The rule execution mode for the rules included in the detector version.

You can define and edit the rule mode at the detector version level, when it is in draft status.

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules.

The default behavior is FIRST_MATCHED.

rules
  • Required: Yes
  • Type: Array of Rule structures

The rules to include in the detector version.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[
    'detectorId' => '<string>',
    'detectorVersionId' => '<string>',
    'status' => 'DRAFT|ACTIVE|INACTIVE',
]

Result Details

Members
detectorId
  • Type: string

The ID for the created version's parent detector.

detectorVersionId
  • Type: string

The ID for the created detector.

status
  • Type: string

The status of the detector version.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CreateModel

$result = $client->createModel([/* ... */]);
$promise = $client->createModelAsync([/* ... */]);

Creates a model using the specified model type.

Parameter Syntax

$result = $client->createModel([
    'description' => '<string>',
    'eventTypeName' => '<string>', // REQUIRED
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The model description.

eventTypeName
  • Required: Yes
  • Type: string

The name of the event type.

modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CreateModelVersion

$result = $client->createModelVersion([/* ... */]);
$promise = $client->createModelVersionAsync([/* ... */]);

Creates a version of the model using the specified model type and model id.

Parameter Syntax

$result = $client->createModelVersion([
    'externalEventsDetail' => [
        'dataAccessRoleArn' => '<string>', // REQUIRED
        'dataLocation' => '<string>', // REQUIRED
    ],
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'trainingDataSchema' => [ // REQUIRED
        'labelSchema' => [ // REQUIRED
            'labelMapper' => [ // REQUIRED
                '<string>' => ['<string>', ...],
                // ...
            ],
        ],
        'modelVariables' => ['<string>', ...], // REQUIRED
    ],
    'trainingDataSource' => 'EXTERNAL_EVENTS', // REQUIRED
]);

Parameter Details

Members
externalEventsDetail
  • Type: ExternalEventsDetail structure

Details for the external events data used for model version training. Required if trainingDataSource is EXTERNAL_EVENTS.

modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

trainingDataSchema
  • Required: Yes
  • Type: TrainingDataSchema structure

The training data schema.

trainingDataSource
  • Required: Yes
  • Type: string

The training data source location in Amazon S3.

Result Syntax

[
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'status' => '<string>',
]

Result Details

Members
modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

modelVersionNumber
  • Type: string

The model version number of the model version created.

status
  • Type: string

The model version status.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • InternalServerException:

    An exception indicating an internal server error.

CreateRule

$result = $client->createRule([/* ... */]);
$promise = $client->createRuleAsync([/* ... */]);

Creates a rule for use with the specified detector.

Parameter Syntax

$result = $client->createRule([
    'description' => '<string>',
    'detectorId' => '<string>', // REQUIRED
    'expression' => '<string>', // REQUIRED
    'language' => 'DETECTORPL', // REQUIRED
    'outcomes' => ['<string>', ...], // REQUIRED
    'ruleId' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The rule description.

detectorId
  • Required: Yes
  • Type: string

The detector ID for the rule's parent detector.

expression
  • Required: Yes
  • Type: string

The rule expression.

language
  • Required: Yes
  • Type: string

The language of the rule.

outcomes
  • Required: Yes
  • Type: Array of strings

The outcome or outcomes returned when the rule expression matches.

ruleId
  • Required: Yes
  • Type: string

The rule ID.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[
    'rule' => [
        'detectorId' => '<string>',
        'ruleId' => '<string>',
        'ruleVersion' => '<string>',
    ],
]

Result Details

Members
rule
  • Type: Rule structure

The created rule.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

CreateVariable

$result = $client->createVariable([/* ... */]);
$promise = $client->createVariableAsync([/* ... */]);

Creates a variable.

Parameter Syntax

$result = $client->createVariable([
    'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE', // REQUIRED
    'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN', // REQUIRED
    'defaultValue' => '<string>', // REQUIRED
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'variableType' => '<string>',
]);

Parameter Details

Members
dataSource
  • Required: Yes
  • Type: string

The source of the data.

dataType
  • Required: Yes
  • Type: string

The data type.

defaultValue
  • Required: Yes
  • Type: string

The default value for the variable when no value is received.

description
  • Type: string

The description.

name
  • Required: Yes
  • Type: string

The name of the variable.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

variableType
  • Type: string

The variable type. For more information see Variable types.

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteDetector

$result = $client->deleteDetector([/* ... */]);
$promise = $client->deleteDetectorAsync([/* ... */]);

Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector.

When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The ID of the detector to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteDetectorVersion

$result = $client->deleteDetectorVersion([/* ... */]);
$promise = $client->deleteDetectorVersionAsync([/* ... */]);

Deletes the detector version. You cannot delete detector versions that are in ACTIVE status.

When you delete a detector version, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

$result = $client->deleteDetectorVersion([
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The ID of the parent detector for the detector version to delete.

detectorVersionId
  • Required: Yes
  • Type: string

The ID of the detector version to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteEntityType

$result = $client->deleteEntityType([/* ... */]);
$promise = $client->deleteEntityTypeAsync([/* ... */]);

Deletes an entity type.

You cannot delete an entity type that is included in an event type.

When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the entity type to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteEvent

$result = $client->deleteEvent([/* ... */]);
$promise = $client->deleteEventAsync([/* ... */]);

Deletes the specified event.

When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

$result = $client->deleteEvent([
    'eventId' => '<string>', // REQUIRED
    'eventTypeName' => '<string>', // REQUIRED
]);

Parameter Details

Members
eventId
  • Required: Yes
  • Type: string

The ID of the event to delete.

eventTypeName
  • Required: Yes
  • Type: string

The name of the event type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • ValidationException:

    An exception indicating a specified value is not allowed.

DeleteEventType

$result = $client->deleteEventType([/* ... */]);
$promise = $client->deleteEventTypeAsync([/* ... */]);

Deletes an event type.

You cannot delete an event type that is used in a detector or a model.

When you delete an entity type, Amazon Fraud Detector permanently deletes that entity type and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the event type to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteExternalModel

$result = $client->deleteExternalModel([/* ... */]);
$promise = $client->deleteExternalModelAsync([/* ... */]);

Removes a SageMaker model from Amazon Fraud Detector.

You can remove an Amazon SageMaker model if it is not associated with a detector version. Removing a SageMaker model disconnects it from Amazon Fraud Detector, but the model remains available in SageMaker.

Parameter Syntax

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

Parameter Details

Members
modelEndpoint
  • Required: Yes
  • Type: string

The endpoint of the Amazon Sagemaker model to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteLabel

$result = $client->deleteLabel([/* ... */]);
$promise = $client->deleteLabelAsync([/* ... */]);

Deletes a label.

You cannot delete labels that are included in an event type in Amazon Fraud Detector.

You cannot delete a label assigned to an event ID. You must first delete the relevant event ID.

When you delete a label, Amazon Fraud Detector permanently deletes that label and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the label to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • InternalServerException:

    An exception indicating an internal server error.

DeleteModel

$result = $client->deleteModel([/* ... */]);
$promise = $client->deleteModelAsync([/* ... */]);

Deletes a model.

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

$result = $client->deleteModel([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
]);

Parameter Details

Members
modelId
  • Required: Yes
  • Type: string

The model ID of the model to delete.

modelType
  • Required: Yes
  • Type: string

The model type of the model to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteModelVersion

$result = $client->deleteModelVersion([/* ... */]);
$promise = $client->deleteModelVersionAsync([/* ... */]);

Deletes a model version.

You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version.

When you delete a model version, Amazon Fraud Detector permanently deletes that model version and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

$result = $client->deleteModelVersion([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'modelVersionNumber' => '<string>', // REQUIRED
]);

Parameter Details

Members
modelId
  • Required: Yes
  • Type: string

The model ID of the model version to delete.

modelType
  • Required: Yes
  • Type: string

The model type of the model version to delete.

modelVersionNumber
  • Required: Yes
  • Type: string

The model version number of the model version to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

DeleteOutcome

$result = $client->deleteOutcome([/* ... */]);
$promise = $client->deleteOutcomeAsync([/* ... */]);

Deletes an outcome.

You cannot delete an outcome that is used in a rule version.

When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the outcome to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteRule

$result = $client->deleteRule([/* ... */]);
$promise = $client->deleteRuleAsync([/* ... */]);

Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.

When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

$result = $client->deleteRule([
    'rule' => [ // REQUIRED
        'detectorId' => '<string>', // REQUIRED
        'ruleId' => '<string>', // REQUIRED
        'ruleVersion' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
rule
  • Required: Yes
  • Type: Rule structure

A rule.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DeleteVariable

$result = $client->deleteVariable([/* ... */]);
$promise = $client->deleteVariableAsync([/* ... */]);

Deletes a variable.

You can't delete variables that are included in an event type in Amazon Fraud Detector.

Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually.

When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
name
  • Required: Yes
  • Type: string

The name of the variable to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DescribeDetector

$result = $client->describeDetector([/* ... */]);
$promise = $client->describeDetectorAsync([/* ... */]);

Gets all versions for a specified detector.

Parameter Syntax

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

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The detector ID.

maxResults
  • Type: int

The maximum number of results to return for the request.

nextToken
  • Type: string

The next token from the previous response.

Result Syntax

[
    'arn' => '<string>',
    'detectorId' => '<string>',
    'detectorVersionSummaries' => [
        [
            'description' => '<string>',
            'detectorVersionId' => '<string>',
            'lastUpdatedTime' => '<string>',
            'status' => 'DRAFT|ACTIVE|INACTIVE',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
arn
  • Type: string

The detector ARN.

detectorId
  • Type: string

The detector ID.

detectorVersionSummaries
  • Type: Array of DetectorVersionSummary structures

The status and description for each detector version.

nextToken
  • Type: string

The next token to be used for subsequent requests.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

DescribeModelVersions

$result = $client->describeModelVersions([/* ... */]);
$promise = $client->describeModelVersionsAsync([/* ... */]);

Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.

Parameter Syntax

$result = $client->describeModelVersions([
    'maxResults' => <integer>,
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to return.

modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

modelVersionNumber
  • Type: string

The model version number.

nextToken
  • Type: string

The next token from the previous results.

Result Syntax

[
    'modelVersionDetails' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'externalEventsDetail' => [
                'dataAccessRoleArn' => '<string>',
                'dataLocation' => '<string>',
            ],
            'lastUpdatedTime' => '<string>',
            'modelId' => '<string>',
            'modelType' => 'ONLINE_FRAUD_INSIGHTS',
            'modelVersionNumber' => '<string>',
            'status' => '<string>',
            'trainingDataSchema' => [
                'labelSchema' => [
                    'labelMapper' => [
                        '<string>' => ['<string>', ...],
                        // ...
                    ],
                ],
                'modelVariables' => ['<string>', ...],
            ],
            'trainingDataSource' => 'EXTERNAL_EVENTS',
            'trainingResult' => [
                'dataValidationMetrics' => [
                    'fieldLevelMessages' => [
                        [
                            'content' => '<string>',
                            'fieldName' => '<string>',
                            'identifier' => '<string>',
                            'title' => '<string>',
                            'type' => '<string>',
                        ],
                        // ...
                    ],
                    'fileLevelMessages' => [
                        [
                            'content' => '<string>',
                            'title' => '<string>',
                            'type' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'trainingMetrics' => [
                    'auc' => <float>,
                    'metricDataPoints' => [
                        [
                            'fpr' => <float>,
                            'precision' => <float>,
                            'threshold' => <float>,
                            'tpr' => <float>,
                        ],
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
modelVersionDetails
  • Type: Array of ModelVersionDetail structures

The model version details.

nextToken
  • Type: string

The next token.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetDetectorVersion

$result = $client->getDetectorVersion([/* ... */]);
$promise = $client->getDetectorVersionAsync([/* ... */]);

Gets a particular detector version.

Parameter Syntax

$result = $client->getDetectorVersion([
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The detector ID.

detectorVersionId
  • Required: Yes
  • Type: string

The detector version ID.

Result Syntax

[
    'arn' => '<string>',
    'createdTime' => '<string>',
    'description' => '<string>',
    'detectorId' => '<string>',
    'detectorVersionId' => '<string>',
    'externalModelEndpoints' => ['<string>', ...],
    'lastUpdatedTime' => '<string>',
    'modelVersions' => [
        [
            'arn' => '<string>',
            'modelId' => '<string>',
            'modelType' => 'ONLINE_FRAUD_INSIGHTS',
            'modelVersionNumber' => '<string>',
        ],
        // ...
    ],
    'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
    'rules' => [
        [
            'detectorId' => '<string>',
            'ruleId' => '<string>',
            'ruleVersion' => '<string>',
        ],
        // ...
    ],
    'status' => 'DRAFT|ACTIVE|INACTIVE',
]

Result Details

Members
arn
  • Type: string

The detector version ARN.

createdTime
  • Type: string

The timestamp when the detector version was created.

description
  • Type: string

The detector version description.

detectorId
  • Type: string

The detector ID.

detectorVersionId
  • Type: string

The detector version ID.

externalModelEndpoints
  • Type: Array of strings

The Amazon SageMaker model endpoints included in the detector version.

lastUpdatedTime
  • Type: string

The timestamp when the detector version was last updated.

modelVersions
  • Type: Array of ModelVersion structures

The model versions included in the detector version.

ruleExecutionMode
  • Type: string

The execution mode of the rule in the dectector

FIRST_MATCHED indicates that Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

ALL_MATCHED indicates that Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

rules
  • Type: Array of Rule structures

The rules included in the detector version.

status
  • Type: string

The status of the detector version.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetDetectors

$result = $client->getDetectors([/* ... */]);
$promise = $client->getDetectorsAsync([/* ... */]);

Gets all detectors or a single detector if a detectorId is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
detectorId
  • Type: string

The detector ID.

maxResults
  • Type: int

The maximum number of objects to return for the request.

nextToken
  • Type: string

The next token for the subsequent request.

Result Syntax

[
    'detectors' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'detectorId' => '<string>',
            'eventTypeName' => '<string>',
            'lastUpdatedTime' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
detectors
  • Type: Array of Detector structures

The detectors.

nextToken
  • Type: string

The next page token.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetEntityTypes

$result = $client->getEntityTypes([/* ... */]);
$promise = $client->getEntityTypesAsync([/* ... */]);

Gets all entity types or a specific entity type if a name is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEntityTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

name
  • Type: string

The name.

nextToken
  • Type: string

The next token for the subsequent request.

Result Syntax

[
    'entityTypes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
entityTypes
  • Type: Array of EntityType structures

An array of entity types.

nextToken
  • Type: string

The next page token.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetEventPrediction

$result = $client->getEventPrediction([/* ... */]);
$promise = $client->getEventPredictionAsync([/* ... */]);

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

Parameter Syntax

$result = $client->getEventPrediction([
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>',
    'entities' => [ // REQUIRED
        [
            'entityId' => '<string>', // REQUIRED
            'entityType' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'eventId' => '<string>', // REQUIRED
    'eventTimestamp' => '<string>', // REQUIRED
    'eventTypeName' => '<string>', // REQUIRED
    'eventVariables' => ['<string>', ...], // REQUIRED
    'externalModelEndpointDataBlobs' => [
        '<string>' => [
            'byteBuffer' => <string || resource || Psr\Http\Message\StreamInterface>,
            'contentType' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The detector ID.

detectorVersionId
  • Type: string

The detector version ID.

entities
  • Required: Yes
  • Type: Array of Entity structures

The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

eventId
  • Required: Yes
  • Type: string

The unique ID used to identify the event.

eventTimestamp
  • Required: Yes
  • Type: string

Timestamp that defines when the event under evaluation occurred.

eventTypeName
  • Required: Yes
  • Type: string

The event type associated with the detector specified for the prediction.

eventVariables
  • Required: Yes
  • Type: Associative array of custom strings keys (variableName) to strings

Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

externalModelEndpointDataBlobs
  • Type: Associative array of custom strings keys (string) to ModelEndpointDataBlob structures

The Amazon SageMaker model endpoint input data blobs.

Result Syntax

[
    'modelScores' => [
        [
            'modelVersion' => [
                'arn' => '<string>',
                'modelId' => '<string>',
                'modelType' => 'ONLINE_FRAUD_INSIGHTS',
                'modelVersionNumber' => '<string>',
            ],
            'scores' => [<float>, ...],
        ],
        // ...
    ],
    'ruleResults' => [
        [
            'outcomes' => ['<string>', ...],
            'ruleId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
modelScores
  • Type: Array of ModelScores structures

The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.

ruleResults
  • Type: Array of RuleResult structures

The results.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • ConflictException:

    An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

    • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

    • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

    • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

GetEventTypes

$result = $client->getEventTypes([/* ... */]);
$promise = $client->getEventTypesAsync([/* ... */]);

Gets all event types or a specific event type if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

name
  • Type: string

The name.

nextToken
  • Type: string

The next token for the subsequent request.

Result Syntax

[
    'eventTypes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'entityTypes' => ['<string>', ...],
            'eventVariables' => ['<string>', ...],
            'labels' => ['<string>', ...],
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
eventTypes
  • Type: Array of EventType structures

An array of event types.

nextToken
  • Type: string

The next page token.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetExternalModels

$result = $client->getExternalModels([/* ... */]);
$promise = $client->getExternalModelsAsync([/* ... */]);

Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

modelEndpoint
  • Type: string

The Amazon SageMaker model endpoint.

nextToken
  • Type: string

The next page token for the request.

Result Syntax

[
    'externalModels' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'inputConfiguration' => [
                'csvInputTemplate' => '<string>',
                'eventTypeName' => '<string>',
                'format' => 'TEXT_CSV|APPLICATION_JSON',
                'jsonInputTemplate' => '<string>',
                'useEventVariables' => true || false,
            ],
            'invokeModelEndpointRoleArn' => '<string>',
            'lastUpdatedTime' => '<string>',
            'modelEndpoint' => '<string>',
            'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED',
            'modelSource' => 'SAGEMAKER',
            'outputConfiguration' => [
                'csvIndexToVariableMap' => ['<string>', ...],
                'format' => 'TEXT_CSV|APPLICATION_JSONLINES',
                'jsonKeyToVariableMap' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
externalModels
  • Type: Array of ExternalModel structures

Gets the Amazon SageMaker models.

nextToken
  • Type: string

The next page token to be used in subsequent requests.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetKMSEncryptionKey

$result = $client->getKMSEncryptionKey([/* ... */]);
$promise = $client->getKMSEncryptionKeyAsync([/* ... */]);

Gets the encryption key if a Key Management Service (KMS) customer master key (CMK) has been specified to be used to encrypt content in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'kmsKey' => [
        'kmsEncryptionKeyArn' => '<string>',
    ],
]

Result Details

Members
kmsKey
  • Type: KMSKey structure

The KMS encryption key.

Errors

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetLabels

$result = $client->getLabels([/* ... */]);
$promise = $client->getLabelsAsync([/* ... */]);

Gets all labels or a specific label if name is provided. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 50 records per page. If you provide a maxResults, the value must be between 10 and 50. To get the next page results, provide the pagination token from the GetGetLabelsResponse as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

name
  • Type: string

The name of the label or labels to get.

nextToken
  • Type: string

The next token for the subsequent request.

Result Syntax

[
    'labels' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
labels
  • Type: Array of Label structures

An array of labels.

nextToken
  • Type: string

The next page token.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetModelVersion

$result = $client->getModelVersion([/* ... */]);
$promise = $client->getModelVersionAsync([/* ... */]);

Gets the details of the specified model version.

Parameter Syntax

$result = $client->getModelVersion([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'modelVersionNumber' => '<string>', // REQUIRED
]);

Parameter Details

Members
modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

modelVersionNumber
  • Required: Yes
  • Type: string

The model version number.

Result Syntax

[
    'arn' => '<string>',
    'externalEventsDetail' => [
        'dataAccessRoleArn' => '<string>',
        'dataLocation' => '<string>',
    ],
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'status' => '<string>',
    'trainingDataSchema' => [
        'labelSchema' => [
            'labelMapper' => [
                '<string>' => ['<string>', ...],
                // ...
            ],
        ],
        'modelVariables' => ['<string>', ...],
    ],
    'trainingDataSource' => 'EXTERNAL_EVENTS',
]

Result Details

Members
arn
  • Type: string

The model version ARN.

externalEventsDetail
  • Type: ExternalEventsDetail structure

The event details.

modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

modelVersionNumber
  • Type: string

The model version number.

status
  • Type: string

The model version status.

Possible values are:

  • TRAINING_IN_PROGRESS

  • TRAINING_COMPLETE

  • ACTIVATE_REQUESTED

  • ACTIVATE_IN_PROGRESS

  • ACTIVE

  • INACTIVATE_REQUESTED

  • INACTIVATE_IN_PROGRESS

  • INACTIVE

  • ERROR

trainingDataSchema
  • Type: TrainingDataSchema structure

The training data schema.

trainingDataSource
  • Type: string

The training data source.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetModels

$result = $client->getModels([/* ... */]);
$promise = $client->getModelsAsync([/* ... */]);

Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

$result = $client->getModels([
    'maxResults' => <integer>,
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

nextToken
  • Type: string

The next token for the subsequent request.

Result Syntax

[
    'models' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'eventTypeName' => '<string>',
            'lastUpdatedTime' => '<string>',
            'modelId' => '<string>',
            'modelType' => 'ONLINE_FRAUD_INSIGHTS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
models
  • Type: Array of Model structures

The array of models.

nextToken
  • Type: string

The next page token to be used in subsequent requests.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetOutcomes

$result = $client->getOutcomes([/* ... */]);
$promise = $client->getOutcomesAsync([/* ... */]);

Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

name
  • Type: string

The name of the outcome or outcomes to get.

nextToken
  • Type: string

The next page token for the request.

Result Syntax

[
    'nextToken' => '<string>',
    'outcomes' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The next page token for subsequent requests.

outcomes
  • Type: Array of Outcome structures

The outcomes.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetRules

$result = $client->getRules([/* ... */]);
$promise = $client->getRulesAsync([/* ... */]);

Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified.

This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.

Parameter Syntax

$result = $client->getRules([
    'detectorId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'ruleId' => '<string>',
    'ruleVersion' => '<string>',
]);

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The detector ID.

maxResults
  • Type: int

The maximum number of rules to return for the request.

nextToken
  • Type: string

The next page token.

ruleId
  • Type: string

The rule ID.

ruleVersion
  • Type: string

The rule version.

Result Syntax

[
    'nextToken' => '<string>',
    'ruleDetails' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'description' => '<string>',
            'detectorId' => '<string>',
            'expression' => '<string>',
            'language' => 'DETECTORPL',
            'lastUpdatedTime' => '<string>',
            'outcomes' => ['<string>', ...],
            'ruleId' => '<string>',
            'ruleVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The next page token to be used in subsequent requests.

ruleDetails
  • Type: Array of RuleDetail structures

The details of the requested rule.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

GetVariables

$result = $client->getVariables([/* ... */]);
$promise = $client->getVariablesAsync([/* ... */]);

Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The max size per page determined for the get variable request.

name
  • Type: string

The name of the variable.

nextToken
  • Type: string

The next page token of the get variable request.

Result Syntax

[
    'nextToken' => '<string>',
    'variables' => [
        [
            'arn' => '<string>',
            'createdTime' => '<string>',
            'dataSource' => 'EVENT|MODEL_SCORE|EXTERNAL_MODEL_SCORE',
            'dataType' => 'STRING|INTEGER|FLOAT|BOOLEAN',
            'defaultValue' => '<string>',
            'description' => '<string>',
            'lastUpdatedTime' => '<string>',
            'name' => '<string>',
            'variableType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The next page token to be used in subsequent requests.

variables
  • Type: Array of Variable structures

The names of the variables returned.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

ListTagsForResource

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

Lists all tags associated with the resource. This is a paginated API. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of objects to return for the request.

nextToken
  • Type: string

The next token from the previous results.

resourceARN
  • Required: Yes
  • Type: string

The ARN that specifies the resource whose tags you want to list.

Result Syntax

[
    'nextToken' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The next token for subsequent requests.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutDetector

$result = $client->putDetector([/* ... */]);
$promise = $client->putDetectorAsync([/* ... */]);

Creates or updates a detector.

Parameter Syntax

$result = $client->putDetector([
    'description' => '<string>',
    'detectorId' => '<string>', // REQUIRED
    'eventTypeName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The description of the detector.

detectorId
  • Required: Yes
  • Type: string

The detector ID.

eventTypeName
  • Required: Yes
  • Type: string

The name of the event type.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutEntityType

$result = $client->putEntityType([/* ... */]);
$promise = $client->putEntityTypeAsync([/* ... */]);

Creates or updates an entity type. An entity represents who is performing the event. As part of a fraud prediction, you pass the entity ID to indicate the specific entity who performed the event. An entity type classifies the entity. Example classifications include customer, merchant, or account.

Parameter Syntax

$result = $client->putEntityType([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The description.

name
  • Required: Yes
  • Type: string

The name of the entity type.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutEventType

$result = $client->putEventType([/* ... */]);
$promise = $client->putEventTypeAsync([/* ... */]);

Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.

Parameter Syntax

$result = $client->putEventType([
    'description' => '<string>',
    'entityTypes' => ['<string>', ...], // REQUIRED
    'eventVariables' => ['<string>', ...], // REQUIRED
    'labels' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The description of the event type.

entityTypes
  • Required: Yes
  • Type: Array of strings

The entity type for the event type. Example entity types: customer, merchant, account.

eventVariables
  • Required: Yes
  • Type: Array of strings

The event type variables.

labels
  • Type: Array of strings

The event type labels.

name
  • Required: Yes
  • Type: string

The name.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutExternalModel

$result = $client->putExternalModel([/* ... */]);
$promise = $client->putExternalModelAsync([/* ... */]);

Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.

Parameter Syntax

$result = $client->putExternalModel([
    'inputConfiguration' => [ // REQUIRED
        'csvInputTemplate' => '<string>',
        'eventTypeName' => '<string>',
        'format' => 'TEXT_CSV|APPLICATION_JSON',
        'jsonInputTemplate' => '<string>',
        'useEventVariables' => true || false, // REQUIRED
    ],
    'invokeModelEndpointRoleArn' => '<string>', // REQUIRED
    'modelEndpoint' => '<string>', // REQUIRED
    'modelEndpointStatus' => 'ASSOCIATED|DISSOCIATED', // REQUIRED
    'modelSource' => 'SAGEMAKER', // REQUIRED
    'outputConfiguration' => [ // REQUIRED
        'csvIndexToVariableMap' => ['<string>', ...],
        'format' => 'TEXT_CSV|APPLICATION_JSONLINES', // REQUIRED
        'jsonKeyToVariableMap' => ['<string>', ...],
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
inputConfiguration
  • Required: Yes
  • Type: ModelInputConfiguration structure

The model endpoint input configuration.

invokeModelEndpointRoleArn
  • Required: Yes
  • Type: string

The IAM role used to invoke the model endpoint.

modelEndpoint
  • Required: Yes
  • Type: string

The model endpoints name.

modelEndpointStatus
  • Required: Yes
  • Type: string

The model endpoint’s status in Amazon Fraud Detector.

modelSource
  • Required: Yes
  • Type: string

The source of the model.

outputConfiguration
  • Required: Yes
  • Type: ModelOutputConfiguration structure

The model endpoint output configuration.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutKMSEncryptionKey

$result = $client->putKMSEncryptionKey([/* ... */]);
$promise = $client->putKMSEncryptionKeyAsync([/* ... */]);

Specifies the Key Management Service (KMS) customer master key (CMK) to be used to encrypt content in Amazon Fraud Detector.

Parameter Syntax

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

Parameter Details

Members
kmsEncryptionKeyArn
  • Required: Yes
  • Type: string

The KMS encryption key ARN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutLabel

$result = $client->putLabel([/* ... */]);
$promise = $client->putLabelAsync([/* ... */]);

Creates or updates label. A label classifies an event as fraudulent or legitimate. Labels are associated with event types and used to train supervised machine learning models in Amazon Fraud Detector.

Parameter Syntax

$result = $client->putLabel([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The label description.

name
  • Required: Yes
  • Type: string

The label name.

tags
  • Type: Array of Tag structures

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

PutOutcome

$result = $client->putOutcome([/* ... */]);
$promise = $client->putOutcomeAsync([/* ... */]);

Creates or updates an outcome.

Parameter Syntax

$result = $client->putOutcome([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The outcome description.

name
  • Required: Yes
  • Type: string

The name of the outcome.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

TagResource

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

Assigns tags to a resource.

Parameter Syntax

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

Parameter Details

Members
resourceARN
  • Required: Yes
  • Type: string

The resource ARN.

tags
  • Required: Yes
  • Type: Array of Tag structures

The tags to assign to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UntagResource

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

Removes tags from a resource.

Parameter Syntax

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

Parameter Details

Members
resourceARN
  • Required: Yes
  • Type: string

The ARN of the resource from which to remove the tag.

tagKeys
  • Required: Yes
  • Type: Array of strings

The resource ARN.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateDetectorVersion

$result = $client->updateDetectorVersion([/* ... */]);
$promise = $client->updateDetectorVersionAsync([/* ... */]);

Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, rule execution mode, and description. You can only update a DRAFT detector version.

Parameter Syntax

$result = $client->updateDetectorVersion([
    'description' => '<string>',
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>', // REQUIRED
    'externalModelEndpoints' => ['<string>', ...], // REQUIRED
    'modelVersions' => [
        [
            'arn' => '<string>',
            'modelId' => '<string>', // REQUIRED
            'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
            'modelVersionNumber' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ruleExecutionMode' => 'ALL_MATCHED|FIRST_MATCHED',
    'rules' => [ // REQUIRED
        [
            'detectorId' => '<string>', // REQUIRED
            'ruleId' => '<string>', // REQUIRED
            'ruleVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The detector version description.

detectorId
  • Required: Yes
  • Type: string

The parent detector ID for the detector version you want to update.

detectorVersionId
  • Required: Yes
  • Type: string

The detector version ID.

externalModelEndpoints
  • Required: Yes
  • Type: Array of strings

The Amazon SageMaker model endpoints to include in the detector version.

modelVersions
  • Type: Array of ModelVersion structures

The model versions to include in the detector version.

ruleExecutionMode
  • Type: string

The rule execution mode to add to the detector.

If you specify FIRST_MATCHED, Amazon Fraud Detector evaluates rules sequentially, first to last, stopping at the first matched rule. Amazon Fraud dectector then provides the outcomes for that single rule.

If you specifiy ALL_MATCHED, Amazon Fraud Detector evaluates all rules and returns the outcomes for all matched rules. You can define and edit the rule mode at the detector version level, when it is in draft status.

The default behavior is FIRST_MATCHED.

rules
  • Required: Yes
  • Type: Array of Rule structures

The rules to include in the detector version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateDetectorVersionMetadata

$result = $client->updateDetectorVersionMetadata([/* ... */]);
$promise = $client->updateDetectorVersionMetadataAsync([/* ... */]);

Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE, or INACTIVE).

Parameter Syntax

$result = $client->updateDetectorVersionMetadata([
    'description' => '<string>', // REQUIRED
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>', // REQUIRED
]);

Parameter Details

Members
description
  • Required: Yes
  • Type: string

The description.

detectorId
  • Required: Yes
  • Type: string

The detector ID.

detectorVersionId
  • Required: Yes
  • Type: string

The detector version ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateDetectorVersionStatus

$result = $client->updateDetectorVersionStatus([/* ... */]);
$promise = $client->updateDetectorVersionStatusAsync([/* ... */]);

Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus: DRAFT to ACTIVE, ACTIVE to INACTIVE, and INACTIVE to ACTIVE.

Parameter Syntax

$result = $client->updateDetectorVersionStatus([
    'detectorId' => '<string>', // REQUIRED
    'detectorVersionId' => '<string>', // REQUIRED
    'status' => 'DRAFT|ACTIVE|INACTIVE', // REQUIRED
]);

Parameter Details

Members
detectorId
  • Required: Yes
  • Type: string

The detector ID.

detectorVersionId
  • Required: Yes
  • Type: string

The detector version ID.

status
  • Required: Yes
  • Type: string

The new status.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateModel

$result = $client->updateModel([/* ... */]);
$promise = $client->updateModelAsync([/* ... */]);

Updates a model. You can update the description attribute using this action.

Parameter Syntax

$result = $client->updateModel([
    'description' => '<string>',
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
]);

Parameter Details

Members
description
  • Type: string

The new model description.

modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateModelVersion

$result = $client->updateModelVersion([/* ... */]);
$promise = $client->updateModelVersionAsync([/* ... */]);

Updates a model version. Updating a model version retrains an existing model version using updated training data and produces a new minor version of the model. You can update the training data set location and data access role attributes using this action. This action creates and trains a new minor version of the model, for example version 1.01, 1.02, 1.03.

Parameter Syntax

$result = $client->updateModelVersion([
    'externalEventsDetail' => [
        'dataAccessRoleArn' => '<string>', // REQUIRED
        'dataLocation' => '<string>', // REQUIRED
    ],
    'majorVersionNumber' => '<string>', // REQUIRED
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
externalEventsDetail
  • Type: ExternalEventsDetail structure

The event details.

majorVersionNumber
  • Required: Yes
  • Type: string

The major version number.

modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

tags
  • Type: Array of Tag structures

A collection of key and value pairs.

Result Syntax

[
    'modelId' => '<string>',
    'modelType' => 'ONLINE_FRAUD_INSIGHTS',
    'modelVersionNumber' => '<string>',
    'status' => '<string>',
]

Result Details

Members
modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

modelVersionNumber
  • Type: string

The model version number of the model version updated.

status
  • Type: string

The status of the updated model version.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

  • InternalServerException:

    An exception indicating an internal server error.

UpdateModelVersionStatus

$result = $client->updateModelVersionStatus([/* ... */]);
$promise = $client->updateModelVersionStatusAsync([/* ... */]);

Updates the status of a model version.

You can perform the following status updates:

  1. Change the TRAINING_COMPLETE status to ACTIVE.

  2. Change ACTIVEto INACTIVE.

Parameter Syntax

$result = $client->updateModelVersionStatus([
    'modelId' => '<string>', // REQUIRED
    'modelType' => 'ONLINE_FRAUD_INSIGHTS', // REQUIRED
    'modelVersionNumber' => '<string>', // REQUIRED
    'status' => 'ACTIVE|INACTIVE|TRAINING_CANCELLED', // REQUIRED
]);

Parameter Details

Members
modelId
  • Required: Yes
  • Type: string

The model ID of the model version to update.

modelType
  • Required: Yes
  • Type: string

The model type.

modelVersionNumber
  • Required: Yes
  • Type: string

The model version number.

status
  • Required: Yes
  • Type: string

The model version status.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateRuleMetadata

$result = $client->updateRuleMetadata([/* ... */]);
$promise = $client->updateRuleMetadataAsync([/* ... */]);

Updates a rule's metadata. The description attribute can be updated.

Parameter Syntax

$result = $client->updateRuleMetadata([
    'description' => '<string>', // REQUIRED
    'rule' => [ // REQUIRED
        'detectorId' => '<string>', // REQUIRED
        'ruleId' => '<string>', // REQUIRED
        'ruleVersion' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
description
  • Required: Yes
  • Type: string

The rule description.

rule
  • Required: Yes
  • Type: Rule structure

The rule to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateRuleVersion

$result = $client->updateRuleVersion([/* ... */]);
$promise = $client->updateRuleVersionAsync([/* ... */]);

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

Parameter Syntax

$result = $client->updateRuleVersion([
    'description' => '<string>',
    'expression' => '<string>', // REQUIRED
    'language' => 'DETECTORPL', // REQUIRED
    'outcomes' => ['<string>', ...], // REQUIRED
    'rule' => [ // REQUIRED
        'detectorId' => '<string>', // REQUIRED
        'ruleId' => '<string>', // REQUIRED
        'ruleVersion' => '<string>', // REQUIRED
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
description
  • Type: string

The description.

expression
  • Required: Yes
  • Type: string

The rule expression.

language
  • Required: Yes
  • Type: string

The language.

outcomes
  • Required: Yes
  • Type: Array of strings

The outcomes.

rule
  • Required: Yes
  • Type: Rule structure

The rule to update.

tags
  • Type: Array of Tag structures

The tags to assign to the rule version.

Result Syntax

[
    'rule' => [
        'detectorId' => '<string>',
        'ruleId' => '<string>',
        'ruleVersion' => '<string>',
    ],
]

Result Details

Members
rule
  • Type: Rule structure

The new rule version that was created.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

UpdateVariable

$result = $client->updateVariable([/* ... */]);
$promise = $client->updateVariableAsync([/* ... */]);

Updates a variable.

Parameter Syntax

$result = $client->updateVariable([
    'defaultValue' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'variableType' => '<string>',
]);

Parameter Details

Members
defaultValue
  • Type: string

The new default value of the variable.

description
  • Type: string

The new description.

name
  • Required: Yes
  • Type: string

The name of the variable.

variableType
  • Type: string

The variable type. For more information see Variable types.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    An exception indicating a specified value is not allowed.

  • ResourceNotFoundException:

    An exception indicating the specified resource was not found.

  • InternalServerException:

    An exception indicating an internal server error.

  • ThrottlingException:

    An exception indicating a throttling error.

  • AccessDeniedException:

    An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

Shapes

AccessDeniedException

Description

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.

Members
message
  • Required: Yes
  • Type: string

BatchCreateVariableError

Description

Provides the error of the batch create variable API.

Members
code
  • Type: int

The error code.

message
  • Type: string

The error message.

name
  • Type: string

The name.

BatchGetVariableError

Description

Provides the error of the batch get variable API.

Members
code
  • Type: int

The error code.

message
  • Type: string

The error message.

name
  • Type: string

The error name.

ConflictException

Description

An exception indicating there was a conflict during a delete operation. The following delete operations can cause a conflict exception:

  • DeleteDetector: A conflict exception will occur if the detector has associated Rules or DetectorVersions. You can only delete a detector if it has no Rules or DetectorVersions.

  • DeleteDetectorVersion: A conflict exception will occur if the DetectorVersion status is ACTIVE.

  • DeleteRule: A conflict exception will occur if the RuleVersion is in use by an associated ACTIVE or INACTIVE DetectorVersion.

Members
message
  • Required: Yes
  • Type: string

DataValidationMetrics

Description

The model training validation messages.

Members
fieldLevelMessages
  • Type: Array of FieldValidationMessage structures

The field-specific model training validation messages.

fileLevelMessages
  • Type: Array of FileValidationMessage structures

The file-specific model training validation messages.

Detector

Description

The detector.

Members
arn
  • Type: string

The detector ARN.

createdTime
  • Type: string

Timestamp of when the detector was created.

description
  • Type: string

The detector description.

detectorId
  • Type: string

The detector ID.

eventTypeName
  • Type: string

The name of the event type.

lastUpdatedTime
  • Type: string

Timestamp of when the detector was last updated.

DetectorVersionSummary

Description

The summary of the detector version.

Members
description
  • Type: string

The detector version description.

detectorVersionId
  • Type: string

The detector version ID.

lastUpdatedTime
  • Type: string

Timestamp of when the detector version was last updated.

status
  • Type: string

The detector version status.

Entity

Description

The entity details.

Members
entityId
  • Required: Yes
  • Type: string

The entity ID. If you do not know the entityId, you can pass unknown, which is areserved string literal.

entityType
  • Required: Yes
  • Type: string

The entity type.

EntityType

Description

The entity type details.

Members
arn
  • Type: string

The entity type ARN.

createdTime
  • Type: string

Timestamp of when the entity type was created.

description
  • Type: string

The entity type description.

lastUpdatedTime
  • Type: string

Timestamp of when the entity type was last updated.

name
  • Type: string

The entity type name.

EventType

Description

The event type details.

Members
arn
  • Type: string

The entity type ARN.

createdTime
  • Type: string

Timestamp of when the event type was created.

description
  • Type: string

The event type description.

entityTypes
  • Type: Array of strings

The event type entity types.

eventVariables
  • Type: Array of strings

The event type event variables.

labels
  • Type: Array of strings

The event type labels.

lastUpdatedTime
  • Type: string

Timestamp of when the event type was last updated.

name
  • Type: string

The event type name.

ExternalEventsDetail

Description

Details for the external events data used for model version training.

Members
dataAccessRoleArn
  • Required: Yes
  • Type: string

The ARN of the role that provides Amazon Fraud Detector access to the data location.

dataLocation
  • Required: Yes
  • Type: string

The Amazon S3 bucket location for the data.

ExternalModel

Description

The Amazon SageMaker model.

Members
arn
  • Type: string

The model ARN.

createdTime
  • Type: string

Timestamp of when the model was last created.

inputConfiguration
  • Type: ModelInputConfiguration structure

The input configuration.

invokeModelEndpointRoleArn
  • Type: string

The role used to invoke the model.

lastUpdatedTime
  • Type: string

Timestamp of when the model was last updated.

modelEndpoint
  • Type: string

The Amazon SageMaker model endpoints.

modelEndpointStatus
  • Type: string

The Amazon Fraud Detector status for the external model endpoint

modelSource
  • Type: string

The source of the model.

outputConfiguration
  • Type: ModelOutputConfiguration structure

The output configuration.

FieldValidationMessage

Description

The message details.

Members
content
  • Type: string

The message content.

fieldName
  • Type: string

The field name.

identifier
  • Type: string

The message ID.

title
  • Type: string

The message title.

type
  • Type: string

The message type.

FileValidationMessage

Description

The message details.

Members
content
  • Type: string

The message content.

title
  • Type: string

The message title.

type
  • Type: string

The message type.

InternalServerException

Description

An exception indicating an internal server error.

Members
message
  • Required: Yes
  • Type: string

KMSKey

Description

The KMS key details.

Members
kmsEncryptionKeyArn
  • Type: string

The encryption key ARN.

Label

Description

The label details.

Members
arn
  • Type: string

The label ARN.

createdTime
  • Type: string

Timestamp of when the event type was created.

description
  • Type: string

The label description.

lastUpdatedTime
  • Type: string

Timestamp of when the label was last updated.

name
  • Type: string

The label name.

LabelSchema

Description

The label schema.

Members
labelMapper
  • Required: Yes
  • Type: Associative array of custom strings keys (string) to stringss

The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper could be: {"FRAUD" => ["0"], "LEGIT" => ["1"]} or {"FRAUD" => ["false"], "LEGIT" => ["true"]} or {"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.

MetricDataPoint

Description

Model performance metrics data points.

Members
fpr
  • Type: float

The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.

precision
  • Type: float

The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.

threshold
  • Type: float

The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.

tpr
  • Type: float

The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.

Model

Description

The model.

Members
arn
  • Type: string

The ARN of the model.

createdTime
  • Type: string

Timestamp of when the model was created.

description
  • Type: string

The model description.

eventTypeName
  • Type: string

The name of the event type.

lastUpdatedTime
  • Type: string

Timestamp of last time the model was updated.

modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

ModelEndpointDataBlob

Description

A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.

Members
byteBuffer
  • Type: blob (string|resource|Psr\Http\Message\StreamInterface)

The byte buffer of the Amazon SageMaker model endpoint input data blob.

contentType
  • Type: string

The content type of the Amazon SageMaker model endpoint input data blob.

ModelInputConfiguration

Description

The Amazon SageMaker model input configuration.

Members
csvInputTemplate
  • Type: string

Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.

eventTypeName
  • Type: string

The event type name.

format
  • Type: string

The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.

jsonInputTemplate
  • Type: string

Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.

useEventVariables
  • Required: Yes
  • Type: boolean

The event variables.

ModelOutputConfiguration

Description

Provides the Amazon Sagemaker model output configuration.

Members
csvIndexToVariableMap
  • Type: Associative array of custom strings keys (string) to strings

A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.

format
  • Required: Yes
  • Type: string

The format of the model output configuration.

jsonKeyToVariableMap
  • Type: Associative array of custom strings keys (string) to strings

A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.

ModelScores

Description

The fraud prediction scores.

Members
modelVersion
  • Type: ModelVersion structure

The model version.

scores
  • Type: Associative array of custom strings keys (string) to floats

The model's fraud prediction scores.

ModelVersion

Description

The model version.

Members
arn
  • Type: string

The model version ARN.

modelId
  • Required: Yes
  • Type: string

The model ID.

modelType
  • Required: Yes
  • Type: string

The model type.

modelVersionNumber
  • Required: Yes
  • Type: string

The model version number.

ModelVersionDetail

Description

The details of the model version.

Members
arn
  • Type: string

The model version ARN.

createdTime
  • Type: string

The timestamp when the model was created.

externalEventsDetail
  • Type: ExternalEventsDetail structure

The event details.

lastUpdatedTime
  • Type: string

The timestamp when the model was last updated.

modelId
  • Type: string

The model ID.

modelType
  • Type: string

The model type.

modelVersionNumber
  • Type: string

The model version number.

status
  • Type: string

The status of the model version.

trainingDataSchema
  • Type: TrainingDataSchema structure

The training data schema.

trainingDataSource
  • Type: string

The model version training data source.

trainingResult
  • Type: TrainingResult structure

The training results.

Outcome

Description

The outcome.

Members
arn
  • Type: string

The outcome ARN.

createdTime
  • Type: string

The timestamp when the outcome was created.

description
  • Type: string

The outcome description.

lastUpdatedTime
  • Type: string

The timestamp when the outcome was last updated.

name
  • Type: string

The outcome name.

ResourceNotFoundException

Description

An exception indicating the specified resource was not found.

Members
message
  • Required: Yes
  • Type: string

Rule

Description

A rule.

Members
detectorId
  • Required: Yes
  • Type: string

The detector for which the rule is associated.

ruleId
  • Required: Yes
  • Type: string

The rule ID.

ruleVersion
  • Required: Yes
  • Type: string

The rule version.

RuleDetail

Description

The details of the rule.

Members
arn
  • Type: string

The rule ARN.

createdTime
  • Type: string

The timestamp of when the rule was created.

description
  • Type: string

The rule description.

detectorId
  • Type: string

The detector for which the rule is associated.

expression
  • Type: string

The rule expression.

language
  • Type: string

The rule language.

lastUpdatedTime
  • Type: string

Timestamp of the last time the rule was updated.

outcomes
  • Type: Array of strings

The rule outcomes.

ruleId
  • Type: string

The rule ID.

ruleVersion
  • Type: string

The rule version.

RuleResult

Description

The rule results.

Members
outcomes
  • Type: Array of strings

The outcomes of the matched rule, based on the rule execution mode.

ruleId
  • Type: string

The rule ID that was matched, based on the rule execution mode.

Tag

Description

A key and value pair.

Members
key
  • Required: Yes
  • Type: string

A tag key.

value
  • Required: Yes
  • Type: string

A value assigned to a tag key.

ThrottlingException

Description

An exception indicating a throttling error.

Members
message
  • Required: Yes
  • Type: string

TrainingDataSchema

Description

The training data schema.

Members
labelSchema
  • Required: Yes
  • Type: LabelSchema structure

The label schema.

modelVariables
  • Required: Yes
  • Type: Array of strings

The training data schema variables.

TrainingMetrics

Description

The training metric details.

Members
auc
  • Type: float

The area under the curve. This summarizes true positive rate (TPR) and false positive rate (FPR) across all possible model score thresholds. A model with no predictive power has an AUC of 0.5, whereas a perfect model has a score of 1.0.

metricDataPoints
  • Type: Array of MetricDataPoint structures

The data points details.

TrainingResult

Description

The training result details.

Members
dataValidationMetrics
  • Type: DataValidationMetrics structure

The validation metrics.

trainingMetrics
  • Type: TrainingMetrics structure

The training metric details.

ValidationException

Description

An exception indicating a specified value is not allowed.

Members
message
  • Required: Yes
  • Type: string

Variable

Description

The variable.

Members
arn
  • Type: string

The ARN of the variable.

createdTime
  • Type: string

The time when the variable was created.

dataSource
  • Type: string

The data source of the variable.

dataType
  • Type: string

The data type of the variable. For more information see Variable types.

defaultValue
  • Type: string

The default value of the variable.

description
  • Type: string

The description of the variable.

lastUpdatedTime
  • Type: string

The time when variable was last updated.

name
  • Type: string

The name of the variable.

variableType
  • Type: string

The variable type of the variable.

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

VariableEntry

Description

A variable in the list of variables for the batch create variable request.

Members
dataSource
  • Type: string

The data source of the variable.

dataType
  • Type: string

The data type of the variable.

defaultValue
  • Type: string

The default value of the variable.

description
  • Type: string

The description of the variable.

name
  • Type: string

The name of the variable.

variableType
  • Type: string

The type of the variable. For more information see Variable types.

Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

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