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

AWS IoT Events 2018-07-27

Client: Aws\IoTEvents\IoTEventsClient
Service ID: iotevents
Version: 2018-07-27

This page describes the parameters and results for the operations of the AWS IoT Events (2018-07-27), and shows how to use the Aws\IoTEvents\IoTEventsClient object to call the described operations. This documentation is specific to the 2018-07-27 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 */).

  • CreateDetectorModel ( array $params = [] )

    Creates a detector model.

  • CreateInput ( array $params = [] )

    Creates an input.

  • DeleteDetectorModel ( array $params = [] )

    Deletes a detector model.

  • DeleteInput ( array $params = [] )

    Deletes an input.

  • DescribeDetectorModel ( array $params = [] )

    Describes a detector model.

  • DescribeDetectorModelAnalysis ( array $params = [] )

    Retrieves execution information about a detector model analysis

  • DescribeInput ( array $params = [] )

    Describes an input.

  • DescribeLoggingOptions ( array $params = [] )

    Retrieves the current settings of the AWS IoT Events logging options.

  • GetDetectorModelAnalysisResults ( array $params = [] )

    Retrieves one or more analysis results of the detector model.

  • ListDetectorModelVersions ( array $params = [] )

    Lists all the versions of a detector model.

  • ListDetectorModels ( array $params = [] )

    Lists the detector models you have created.

  • ListInputs ( array $params = [] )

    Lists the inputs you have created.

  • ListTagsForResource ( array $params = [] )

    Lists the tags (metadata) you have assigned to the resource.

  • PutLoggingOptions ( array $params = [] )

    Sets or updates the AWS IoT Events logging options.

  • StartDetectorModelAnalysis ( array $params = [] )

    Performs an analysis of your detector model.

  • TagResource ( array $params = [] )

    Adds to or modifies the tags of the given resource.

  • UntagResource ( array $params = [] )

    Removes the given tags (metadata) from the resource.

  • UpdateDetectorModel ( array $params = [] )

    Updates a detector model.

  • UpdateInput ( array $params = [] )

    Updates an input.

Operations

CreateDetectorModel

$result = $client->createDetectorModel([/* ... */]);
$promise = $client->createDetectorModelAsync([/* ... */]);

Creates a detector model.

Parameter Syntax

$result = $client->createDetectorModel([
    'detectorModelDefinition' => [ // REQUIRED
        'initialStateName' => '<string>', // REQUIRED
        'states' => [ // REQUIRED
            [
                'onEnter' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onExit' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onInput' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'transitionEvents' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>', // REQUIRED
                            'eventName' => '<string>', // REQUIRED
                            'nextState' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'stateName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'detectorModelDescription' => '<string>',
    'detectorModelName' => '<string>', // REQUIRED
    'evaluationMethod' => 'BATCH|SERIAL',
    'key' => '<string>',
    'roleArn' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
detectorModelDefinition
  • Required: Yes
  • Type: DetectorModelDefinition structure

Information that defines how the detectors operate.

detectorModelDescription
  • Type: string

A brief description of the detector model.

detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model.

evaluationMethod
  • Type: string

Information about the order in which events are evaluated and how actions are executed.

key
  • Type: string

The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input.

roleArn
  • Required: Yes
  • Type: string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

tags
  • Type: Array of Tag structures

Metadata that can be used to manage the detector model.

Result Syntax

[
    'detectorModelConfiguration' => [
        'creationTime' => <DateTime>,
        'detectorModelArn' => '<string>',
        'detectorModelDescription' => '<string>',
        'detectorModelName' => '<string>',
        'detectorModelVersion' => '<string>',
        'evaluationMethod' => 'BATCH|SERIAL',
        'key' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
    ],
]

Result Details

Members
detectorModelConfiguration
  • Type: DetectorModelConfiguration structure

Information about how the detector model is configured.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceInUseException:

    The resource is in use.

  • ResourceAlreadyExistsException:

    The resource already exists.

  • LimitExceededException:

    A limit was exceeded.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

CreateInput

$result = $client->createInput([/* ... */]);
$promise = $client->createInputAsync([/* ... */]);

Creates an input.

Parameter Syntax

$result = $client->createInput([
    'inputDefinition' => [ // REQUIRED
        'attributes' => [ // REQUIRED
            [
                'jsonPath' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'inputDescription' => '<string>',
    'inputName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
inputDefinition
  • Required: Yes
  • Type: InputDefinition structure

The definition of the input.

inputDescription
  • Type: string

A brief description of the input.

inputName
  • Required: Yes
  • Type: string

The name you want to give to the input.

tags
  • Type: Array of Tag structures

Metadata that can be used to manage the input.

Result Syntax

[
    'inputConfiguration' => [
        'creationTime' => <DateTime>,
        'inputArn' => '<string>',
        'inputDescription' => '<string>',
        'inputName' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
    ],
]

Result Details

Members
inputConfiguration
  • Type: InputConfiguration structure

Information about the configuration of the input.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

  • ResourceAlreadyExistsException:

    The resource already exists.

DeleteDetectorModel

$result = $client->deleteDetectorModel([/* ... */]);
$promise = $client->deleteDetectorModelAsync([/* ... */]);

Deletes a detector model. Any active instances of the detector model are also deleted.

Parameter Syntax

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

Parameter Details

Members
detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceInUseException:

    The resource is in use.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

DeleteInput

$result = $client->deleteInput([/* ... */]);
$promise = $client->deleteInputAsync([/* ... */]);

Deletes an input.

Parameter Syntax

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

Parameter Details

Members
inputName
  • Required: Yes
  • Type: string

The name of the input to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

  • ResourceInUseException:

    The resource is in use.

DescribeDetectorModel

$result = $client->describeDetectorModel([/* ... */]);
$promise = $client->describeDetectorModelAsync([/* ... */]);

Describes a detector model. If the version parameter is not specified, information about the latest version is returned.

Parameter Syntax

$result = $client->describeDetectorModel([
    'detectorModelName' => '<string>', // REQUIRED
    'detectorModelVersion' => '<string>',
]);

Parameter Details

Members
detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model.

detectorModelVersion
  • Type: string

The version of the detector model.

Result Syntax

[
    'detectorModel' => [
        'detectorModelConfiguration' => [
            'creationTime' => <DateTime>,
            'detectorModelArn' => '<string>',
            'detectorModelDescription' => '<string>',
            'detectorModelName' => '<string>',
            'detectorModelVersion' => '<string>',
            'evaluationMethod' => 'BATCH|SERIAL',
            'key' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'roleArn' => '<string>',
            'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
        ],
        'detectorModelDefinition' => [
            'initialStateName' => '<string>',
            'states' => [
                [
                    'onEnter' => [
                        'events' => [
                            [
                                'actions' => [
                                    [
                                        'clearTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'dynamoDB' => [
                                            'hashKeyField' => '<string>',
                                            'hashKeyType' => '<string>',
                                            'hashKeyValue' => '<string>',
                                            'operation' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'payloadField' => '<string>',
                                            'rangeKeyField' => '<string>',
                                            'rangeKeyType' => '<string>',
                                            'rangeKeyValue' => '<string>',
                                            'tableName' => '<string>',
                                        ],
                                        'dynamoDBv2' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'tableName' => '<string>',
                                        ],
                                        'firehose' => [
                                            'deliveryStreamName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'separator' => '<string>',
                                        ],
                                        'iotEvents' => [
                                            'inputName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'iotSiteWise' => [
                                            'assetId' => '<string>',
                                            'entryId' => '<string>',
                                            'propertyAlias' => '<string>',
                                            'propertyId' => '<string>',
                                            'propertyValue' => [
                                                'quality' => '<string>',
                                                'timestamp' => [
                                                    'offsetInNanos' => '<string>',
                                                    'timeInSeconds' => '<string>',
                                                ],
                                                'value' => [
                                                    'booleanValue' => '<string>',
                                                    'doubleValue' => '<string>',
                                                    'integerValue' => '<string>',
                                                    'stringValue' => '<string>',
                                                ],
                                            ],
                                        ],
                                        'iotTopicPublish' => [
                                            'mqttTopic' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'lambda' => [
                                            'functionArn' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'resetTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'setTimer' => [
                                            'durationExpression' => '<string>',
                                            'seconds' => <integer>,
                                            'timerName' => '<string>',
                                        ],
                                        'setVariable' => [
                                            'value' => '<string>',
                                            'variableName' => '<string>',
                                        ],
                                        'sns' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'targetArn' => '<string>',
                                        ],
                                        'sqs' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'queueUrl' => '<string>',
                                            'useBase64' => true || false,
                                        ],
                                    ],
                                    // ...
                                ],
                                'condition' => '<string>',
                                'eventName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'onExit' => [
                        'events' => [
                            [
                                'actions' => [
                                    [
                                        'clearTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'dynamoDB' => [
                                            'hashKeyField' => '<string>',
                                            'hashKeyType' => '<string>',
                                            'hashKeyValue' => '<string>',
                                            'operation' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'payloadField' => '<string>',
                                            'rangeKeyField' => '<string>',
                                            'rangeKeyType' => '<string>',
                                            'rangeKeyValue' => '<string>',
                                            'tableName' => '<string>',
                                        ],
                                        'dynamoDBv2' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'tableName' => '<string>',
                                        ],
                                        'firehose' => [
                                            'deliveryStreamName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'separator' => '<string>',
                                        ],
                                        'iotEvents' => [
                                            'inputName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'iotSiteWise' => [
                                            'assetId' => '<string>',
                                            'entryId' => '<string>',
                                            'propertyAlias' => '<string>',
                                            'propertyId' => '<string>',
                                            'propertyValue' => [
                                                'quality' => '<string>',
                                                'timestamp' => [
                                                    'offsetInNanos' => '<string>',
                                                    'timeInSeconds' => '<string>',
                                                ],
                                                'value' => [
                                                    'booleanValue' => '<string>',
                                                    'doubleValue' => '<string>',
                                                    'integerValue' => '<string>',
                                                    'stringValue' => '<string>',
                                                ],
                                            ],
                                        ],
                                        'iotTopicPublish' => [
                                            'mqttTopic' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'lambda' => [
                                            'functionArn' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'resetTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'setTimer' => [
                                            'durationExpression' => '<string>',
                                            'seconds' => <integer>,
                                            'timerName' => '<string>',
                                        ],
                                        'setVariable' => [
                                            'value' => '<string>',
                                            'variableName' => '<string>',
                                        ],
                                        'sns' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'targetArn' => '<string>',
                                        ],
                                        'sqs' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'queueUrl' => '<string>',
                                            'useBase64' => true || false,
                                        ],
                                    ],
                                    // ...
                                ],
                                'condition' => '<string>',
                                'eventName' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'onInput' => [
                        'events' => [
                            [
                                'actions' => [
                                    [
                                        'clearTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'dynamoDB' => [
                                            'hashKeyField' => '<string>',
                                            'hashKeyType' => '<string>',
                                            'hashKeyValue' => '<string>',
                                            'operation' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'payloadField' => '<string>',
                                            'rangeKeyField' => '<string>',
                                            'rangeKeyType' => '<string>',
                                            'rangeKeyValue' => '<string>',
                                            'tableName' => '<string>',
                                        ],
                                        'dynamoDBv2' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'tableName' => '<string>',
                                        ],
                                        'firehose' => [
                                            'deliveryStreamName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'separator' => '<string>',
                                        ],
                                        'iotEvents' => [
                                            'inputName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'iotSiteWise' => [
                                            'assetId' => '<string>',
                                            'entryId' => '<string>',
                                            'propertyAlias' => '<string>',
                                            'propertyId' => '<string>',
                                            'propertyValue' => [
                                                'quality' => '<string>',
                                                'timestamp' => [
                                                    'offsetInNanos' => '<string>',
                                                    'timeInSeconds' => '<string>',
                                                ],
                                                'value' => [
                                                    'booleanValue' => '<string>',
                                                    'doubleValue' => '<string>',
                                                    'integerValue' => '<string>',
                                                    'stringValue' => '<string>',
                                                ],
                                            ],
                                        ],
                                        'iotTopicPublish' => [
                                            'mqttTopic' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'lambda' => [
                                            'functionArn' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'resetTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'setTimer' => [
                                            'durationExpression' => '<string>',
                                            'seconds' => <integer>,
                                            'timerName' => '<string>',
                                        ],
                                        'setVariable' => [
                                            'value' => '<string>',
                                            'variableName' => '<string>',
                                        ],
                                        'sns' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'targetArn' => '<string>',
                                        ],
                                        'sqs' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'queueUrl' => '<string>',
                                            'useBase64' => true || false,
                                        ],
                                    ],
                                    // ...
                                ],
                                'condition' => '<string>',
                                'eventName' => '<string>',
                            ],
                            // ...
                        ],
                        'transitionEvents' => [
                            [
                                'actions' => [
                                    [
                                        'clearTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'dynamoDB' => [
                                            'hashKeyField' => '<string>',
                                            'hashKeyType' => '<string>',
                                            'hashKeyValue' => '<string>',
                                            'operation' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'payloadField' => '<string>',
                                            'rangeKeyField' => '<string>',
                                            'rangeKeyType' => '<string>',
                                            'rangeKeyValue' => '<string>',
                                            'tableName' => '<string>',
                                        ],
                                        'dynamoDBv2' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'tableName' => '<string>',
                                        ],
                                        'firehose' => [
                                            'deliveryStreamName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'separator' => '<string>',
                                        ],
                                        'iotEvents' => [
                                            'inputName' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'iotSiteWise' => [
                                            'assetId' => '<string>',
                                            'entryId' => '<string>',
                                            'propertyAlias' => '<string>',
                                            'propertyId' => '<string>',
                                            'propertyValue' => [
                                                'quality' => '<string>',
                                                'timestamp' => [
                                                    'offsetInNanos' => '<string>',
                                                    'timeInSeconds' => '<string>',
                                                ],
                                                'value' => [
                                                    'booleanValue' => '<string>',
                                                    'doubleValue' => '<string>',
                                                    'integerValue' => '<string>',
                                                    'stringValue' => '<string>',
                                                ],
                                            ],
                                        ],
                                        'iotTopicPublish' => [
                                            'mqttTopic' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'lambda' => [
                                            'functionArn' => '<string>',
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                        ],
                                        'resetTimer' => [
                                            'timerName' => '<string>',
                                        ],
                                        'setTimer' => [
                                            'durationExpression' => '<string>',
                                            'seconds' => <integer>,
                                            'timerName' => '<string>',
                                        ],
                                        'setVariable' => [
                                            'value' => '<string>',
                                            'variableName' => '<string>',
                                        ],
                                        'sns' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'targetArn' => '<string>',
                                        ],
                                        'sqs' => [
                                            'payload' => [
                                                'contentExpression' => '<string>',
                                                'type' => 'STRING|JSON',
                                            ],
                                            'queueUrl' => '<string>',
                                            'useBase64' => true || false,
                                        ],
                                    ],
                                    // ...
                                ],
                                'condition' => '<string>',
                                'eventName' => '<string>',
                                'nextState' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'stateName' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Members
detectorModel
  • Type: DetectorModel structure

Information about the detector model.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

DescribeDetectorModelAnalysis

$result = $client->describeDetectorModelAnalysis([/* ... */]);
$promise = $client->describeDetectorModelAnalysisAsync([/* ... */]);

Retrieves execution information about a detector model analysis

Parameter Syntax

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

Parameter Details

Members
analysisId
  • Required: Yes
  • Type: string

The ID of the analysis result that you want to retrieve.

Result Syntax

[
    'status' => 'RUNNING|COMPLETE|FAILED',
]

Result Details

Members
status
  • Type: string

The status of the analysis activity. The status can be one of the following values:

  • RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.

  • COMPLETE - AWS IoT Events finished analyzing your detector model .

  • FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

DescribeInput

$result = $client->describeInput([/* ... */]);
$promise = $client->describeInputAsync([/* ... */]);

Describes an input.

Parameter Syntax

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

Parameter Details

Members
inputName
  • Required: Yes
  • Type: string

The name of the input.

Result Syntax

[
    'input' => [
        'inputConfiguration' => [
            'creationTime' => <DateTime>,
            'inputArn' => '<string>',
            'inputDescription' => '<string>',
            'inputName' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
        ],
        'inputDefinition' => [
            'attributes' => [
                [
                    'jsonPath' => '<string>',
                ],
                // ...
            ],
        ],
    ],
]

Result Details

Members
input
  • Type: Input structure

Information about the input.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

DescribeLoggingOptions

$result = $client->describeLoggingOptions([/* ... */]);
$promise = $client->describeLoggingOptionsAsync([/* ... */]);

Retrieves the current settings of the AWS IoT Events logging options.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'loggingOptions' => [
        'detectorDebugOptions' => [
            [
                'detectorModelName' => '<string>',
                'keyValue' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'level' => 'ERROR|INFO|DEBUG',
        'roleArn' => '<string>',
    ],
]

Result Details

Members
loggingOptions
  • Type: LoggingOptions structure

The current settings of the AWS IoT Events logging options.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ResourceNotFoundException:

    The resource was not found.

  • ServiceUnavailableException:

    The service is currently unavailable.

  • UnsupportedOperationException:

    The requested operation is not supported.

GetDetectorModelAnalysisResults

$result = $client->getDetectorModelAnalysisResults([/* ... */]);
$promise = $client->getDetectorModelAnalysisResultsAsync([/* ... */]);

Retrieves one or more analysis results of the detector model.

Parameter Syntax

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

Parameter Details

Members
analysisId
  • Required: Yes
  • Type: string

The ID of the analysis result that you want to retrieve.

maxResults
  • Type: int

The maximum number of results to be returned per request.

nextToken
  • Type: string

The token that you can use to return the next set of results.

Result Syntax

[
    'analysisResults' => [
        [
            'level' => 'INFO|WARNING|ERROR',
            'locations' => [
                [
                    'path' => '<string>',
                ],
                // ...
            ],
            'message' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
analysisResults
  • Type: Array of AnalysisResult structures

Contains information about one or more analysis results.

nextToken
  • Type: string

The token that you can use to return the next set of results, or null if there are no more results.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

ListDetectorModelVersions

$result = $client->listDetectorModelVersions([/* ... */]);
$promise = $client->listDetectorModelVersionsAsync([/* ... */]);

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

Parameter Syntax

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

Parameter Details

Members
detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model whose versions are returned.

maxResults
  • Type: int

The maximum number of results to be returned per request.

nextToken
  • Type: string

The token that you can use to return the next set of results.

Result Syntax

[
    'detectorModelVersionSummaries' => [
        [
            'creationTime' => <DateTime>,
            'detectorModelArn' => '<string>',
            'detectorModelName' => '<string>',
            'detectorModelVersion' => '<string>',
            'evaluationMethod' => 'BATCH|SERIAL',
            'lastUpdateTime' => <DateTime>,
            'roleArn' => '<string>',
            'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
detectorModelVersionSummaries
  • Type: Array of DetectorModelVersionSummary structures

Summary information about the detector model versions.

nextToken
  • Type: string

The token that you can use to return the next set of results, or null if there are no more results.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

ListDetectorModels

$result = $client->listDetectorModels([/* ... */]);
$promise = $client->listDetectorModelsAsync([/* ... */]);

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to be returned per request.

nextToken
  • Type: string

The token that you can use to return the next set of results.

Result Syntax

[
    'detectorModelSummaries' => [
        [
            'creationTime' => <DateTime>,
            'detectorModelDescription' => '<string>',
            'detectorModelName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
detectorModelSummaries
  • Type: Array of DetectorModelSummary structures

Summary information about the detector models.

nextToken
  • Type: string

The token that you can use to return the next set of results, or null if there are no more results.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

ListInputs

$result = $client->listInputs([/* ... */]);
$promise = $client->listInputsAsync([/* ... */]);

Lists the inputs you have created.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of results to be returned per request.

nextToken
  • Type: string

The token that you can use to return the next set of results.

Result Syntax

[
    'inputSummaries' => [
        [
            'creationTime' => <DateTime>,
            'inputArn' => '<string>',
            'inputDescription' => '<string>',
            'inputName' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
inputSummaries
  • Type: Array of InputSummary structures

Summary information about the inputs.

nextToken
  • Type: string

The token that you can use to return the next set of results, or null if there are no more results.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

ListTagsForResource

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

Lists the tags (metadata) you have assigned to the resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

Result Syntax

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

Result Details

Members
tags
  • Type: Array of Tag structures

The list of tags assigned to the resource.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ResourceInUseException:

    The resource is in use.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

PutLoggingOptions

$result = $client->putLoggingOptions([/* ... */]);
$promise = $client->putLoggingOptionsAsync([/* ... */]);

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

Parameter Syntax

$result = $client->putLoggingOptions([
    'loggingOptions' => [ // REQUIRED
        'detectorDebugOptions' => [
            [
                'detectorModelName' => '<string>', // REQUIRED
                'keyValue' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false, // REQUIRED
        'level' => 'ERROR|INFO|DEBUG', // REQUIRED
        'roleArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
loggingOptions
  • Required: Yes
  • Type: LoggingOptions structure

The new values of the AWS IoT Events logging options.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

  • UnsupportedOperationException:

    The requested operation is not supported.

  • ResourceInUseException:

    The resource is in use.

StartDetectorModelAnalysis

$result = $client->startDetectorModelAnalysis([/* ... */]);
$promise = $client->startDetectorModelAnalysisAsync([/* ... */]);

Performs an analysis of your detector model. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.

Parameter Syntax

$result = $client->startDetectorModelAnalysis([
    'detectorModelDefinition' => [ // REQUIRED
        'initialStateName' => '<string>', // REQUIRED
        'states' => [ // REQUIRED
            [
                'onEnter' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onExit' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onInput' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'transitionEvents' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>', // REQUIRED
                            'eventName' => '<string>', // REQUIRED
                            'nextState' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'stateName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
detectorModelDefinition
  • Required: Yes
  • Type: DetectorModelDefinition structure

Information that defines how a detector operates.

Result Syntax

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

Result Details

Members
analysisId
  • Type: string

The ID that you can use to retrieve the analysis result.

Errors

  • InvalidRequestException:

    The request was invalid.

  • LimitExceededException:

    A limit was exceeded.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

TagResource

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

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage 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 ARN of the resource.

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

The new or modified tags for the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ResourceInUseException:

    The resource is in use.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • LimitExceededException:

    A limit was exceeded.

  • InternalFailureException:

    An internal failure occurred.

UntagResource

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

Removes the given tags (metadata) from the 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.

tagKeys
  • Required: Yes
  • Type: Array of strings

A list of the keys of the tags to be removed from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceNotFoundException:

    The resource was not found.

  • ResourceInUseException:

    The resource is in use.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

UpdateDetectorModel

$result = $client->updateDetectorModel([/* ... */]);
$promise = $client->updateDetectorModelAsync([/* ... */]);

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

Parameter Syntax

$result = $client->updateDetectorModel([
    'detectorModelDefinition' => [ // REQUIRED
        'initialStateName' => '<string>', // REQUIRED
        'states' => [ // REQUIRED
            [
                'onEnter' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onExit' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'onInput' => [
                    'events' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>',
                            'eventName' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'transitionEvents' => [
                        [
                            'actions' => [
                                [
                                    'clearTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDB' => [
                                        'hashKeyField' => '<string>', // REQUIRED
                                        'hashKeyType' => '<string>',
                                        'hashKeyValue' => '<string>', // REQUIRED
                                        'operation' => '<string>',
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'payloadField' => '<string>',
                                        'rangeKeyField' => '<string>',
                                        'rangeKeyType' => '<string>',
                                        'rangeKeyValue' => '<string>',
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'dynamoDBv2' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'tableName' => '<string>', // REQUIRED
                                    ],
                                    'firehose' => [
                                        'deliveryStreamName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'separator' => '<string>',
                                    ],
                                    'iotEvents' => [
                                        'inputName' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'iotSiteWise' => [
                                        'assetId' => '<string>',
                                        'entryId' => '<string>',
                                        'propertyAlias' => '<string>',
                                        'propertyId' => '<string>',
                                        'propertyValue' => [ // REQUIRED
                                            'quality' => '<string>',
                                            'timestamp' => [
                                                'offsetInNanos' => '<string>',
                                                'timeInSeconds' => '<string>', // REQUIRED
                                            ],
                                            'value' => [ // REQUIRED
                                                'booleanValue' => '<string>',
                                                'doubleValue' => '<string>',
                                                'integerValue' => '<string>',
                                                'stringValue' => '<string>',
                                            ],
                                        ],
                                    ],
                                    'iotTopicPublish' => [
                                        'mqttTopic' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'lambda' => [
                                        'functionArn' => '<string>', // REQUIRED
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                    ],
                                    'resetTimer' => [
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setTimer' => [
                                        'durationExpression' => '<string>',
                                        'seconds' => <integer>,
                                        'timerName' => '<string>', // REQUIRED
                                    ],
                                    'setVariable' => [
                                        'value' => '<string>', // REQUIRED
                                        'variableName' => '<string>', // REQUIRED
                                    ],
                                    'sns' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'targetArn' => '<string>', // REQUIRED
                                    ],
                                    'sqs' => [
                                        'payload' => [
                                            'contentExpression' => '<string>', // REQUIRED
                                            'type' => 'STRING|JSON', // REQUIRED
                                        ],
                                        'queueUrl' => '<string>', // REQUIRED
                                        'useBase64' => true || false,
                                    ],
                                ],
                                // ...
                            ],
                            'condition' => '<string>', // REQUIRED
                            'eventName' => '<string>', // REQUIRED
                            'nextState' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                'stateName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'detectorModelDescription' => '<string>',
    'detectorModelName' => '<string>', // REQUIRED
    'evaluationMethod' => 'BATCH|SERIAL',
    'roleArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
detectorModelDefinition
  • Required: Yes
  • Type: DetectorModelDefinition structure

Information that defines how a detector operates.

detectorModelDescription
  • Type: string

A brief description of the detector model.

detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model that is updated.

evaluationMethod
  • Type: string

Information about the order in which events are evaluated and how actions are executed.

roleArn
  • Required: Yes
  • Type: string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Result Syntax

[
    'detectorModelConfiguration' => [
        'creationTime' => <DateTime>,
        'detectorModelArn' => '<string>',
        'detectorModelDescription' => '<string>',
        'detectorModelName' => '<string>',
        'detectorModelVersion' => '<string>',
        'evaluationMethod' => 'BATCH|SERIAL',
        'key' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'roleArn' => '<string>',
        'status' => 'ACTIVE|ACTIVATING|INACTIVE|DEPRECATED|DRAFT|PAUSED|FAILED',
    ],
]

Result Details

Members
detectorModelConfiguration
  • Type: DetectorModelConfiguration structure

Information about how the detector model is configured.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ResourceInUseException:

    The resource is in use.

  • ResourceNotFoundException:

    The resource was not found.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

UpdateInput

$result = $client->updateInput([/* ... */]);
$promise = $client->updateInputAsync([/* ... */]);

Updates an input.

Parameter Syntax

$result = $client->updateInput([
    'inputDefinition' => [ // REQUIRED
        'attributes' => [ // REQUIRED
            [
                'jsonPath' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'inputDescription' => '<string>',
    'inputName' => '<string>', // REQUIRED
]);

Parameter Details

Members
inputDefinition
  • Required: Yes
  • Type: InputDefinition structure

The definition of the input.

inputDescription
  • Type: string

A brief description of the input.

inputName
  • Required: Yes
  • Type: string

The name of the input you want to update.

Result Syntax

[
    'inputConfiguration' => [
        'creationTime' => <DateTime>,
        'inputArn' => '<string>',
        'inputDescription' => '<string>',
        'inputName' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'status' => 'CREATING|UPDATING|ACTIVE|DELETING',
    ],
]

Result Details

Members
inputConfiguration
  • Type: InputConfiguration structure

Information about the configuration of the input.

Errors

  • InvalidRequestException:

    The request was invalid.

  • ThrottlingException:

    The request could not be completed due to throttling.

  • ResourceNotFoundException:

    The resource was not found.

  • InternalFailureException:

    An internal failure occurred.

  • ServiceUnavailableException:

    The service is currently unavailable.

  • ResourceInUseException:

    The resource is in use.

Shapes

Action

Description

An action to be performed when the condition is TRUE.

Members
clearTimer
  • Type: ClearTimerAction structure

Information needed to clear the timer.

dynamoDB
  • Type: DynamoDBAction structure

Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

dynamoDBv2
  • Type: DynamoDBv2Action structure

Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see Actions in AWS IoT Events Developer Guide.

firehose
  • Type: FirehoseAction structure

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

iotEvents
  • Type: IotEventsAction structure

Sends AWS IoT Events input, which passes information about the detector model instance and the event that triggered the action.

iotSiteWise
  • Type: IotSiteWiseAction structure

Sends information about the detector model instance and the event that triggered the action to an asset property in AWS IoT SiteWise .

iotTopicPublish
  • Type: IotTopicPublishAction structure

Publishes an MQTT message with the given topic to the AWS IoT message broker.

lambda
  • Type: LambdaAction structure

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

resetTimer
  • Type: ResetTimerAction structure

Information needed to reset the timer.

setTimer
  • Type: SetTimerAction structure

Information needed to set the timer.

setVariable
  • Type: SetVariableAction structure

Sets a variable to a specified value.

sns
  • Type: SNSTopicPublishAction structure

Sends an Amazon SNS message.

sqs
  • Type: SqsAction structure

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

AnalysisResult

Description

Contains the result of the analysis.

Members
level
  • Type: string

The severity level of the analysis result. Analysis results fall into three general categories based on the severity level:

  • INFO - An information result informs you about a significant field in your detector model. This type of result usually doesn't require immediate action.

  • WARNING - A warning result draws special attention to fields that are potentially damaging to your detector model. We recommend that you review warnings and take necessary actions before you use your detetor model in production environments. Otherwise, the detector model may not fully function as expected.

  • ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.

locations
  • Type: Array of AnalysisResultLocation structures

Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.

message
  • Type: string

Contains additional information about the analysis result.

type
  • Type: string

The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:

  • supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.

  • service-limits - Resources or operations can't exceed service limits. Update your detector model or request a limit adjust.

  • structure - The detector model must follow a structure that AWS IoT Events supports.

  • expression-syntax - Your expression must follow the required syntax.

  • data-type - Data types referenced in the detector model must be compatible.

  • referenced-data - You must define the data referenced in your detector model before you can use the data.

  • referenced-resource - Resources that the detector model uses must be available.

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.

AnalysisResultLocation

Description

Contains information that you can use to locate the field in your detector model that the analysis result references.

Members
path
  • Type: string

A JsonPath expression that identifies the error field in your detector model.

AssetPropertyTimestamp

Description

A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyTimestamp. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675'.

  • For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the timeInSeconds parameter uses a substitution template.

    '${$input.TemperatureInput.sensorData.timestamp / 1000}'

For more information, see Expressions in the AWS IoT Events Developer Guide.

Members
offsetInNanos
  • Type: string

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

timeInSeconds
  • Required: Yes
  • Type: string

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.

AssetPropertyValue

Description

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyValue. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD'.

  • For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality.

For more information, see Expressions in the AWS IoT Events Developer Guide.

Members
quality
  • Type: string

The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.

timestamp
  • Type: AssetPropertyTimestamp structure

The timestamp associated with the asset property value. The default is the current event time.

value
  • Required: Yes
  • Type: AssetPropertyVariant structure

The value to send to an asset property.

AssetPropertyVariant

Description

A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference.

You must use expressions for all parameters in AssetPropertyVariant. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100'.

  • For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the doubleValue parameter uses a substitution template.

    '${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

For more information, see Expressions in the AWS IoT Events Developer Guide.

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference.

Members
booleanValue
  • Type: string

The asset property value is a Boolean value that must be 'TRUE' or 'FALSE'. You must use an expression, and the evaluated result should be a Boolean value.

doubleValue
  • Type: string

The asset property value is a double. You must use an expression, and the evaluated result should be a double.

integerValue
  • Type: string

The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.

stringValue
  • Type: string

The asset property value is a string. You must use an expression, and the evaluated result should be a string.

Attribute

Description

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload. Those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

Members
jsonPath
  • Required: Yes
  • Type: string

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

Syntax: <field-name>.<field-name>...

ClearTimerAction

Description

Information needed to clear the timer.

Members
timerName
  • Required: Yes
  • Type: string

The name of the timer to clear.

DetectorDebugOption

Description

The detector model and the specific detectors (instances) for which the logging level is given.

Members
detectorModelName
  • Required: Yes
  • Type: string

The name of the detector model.

keyValue
  • Type: string

The value of the input attribute key used to create the detector (the instance of the detector model).

DetectorModel

Description

Information about the detector model.

Members
detectorModelConfiguration
  • Type: DetectorModelConfiguration structure

Information about how the detector is configured.

detectorModelDefinition
  • Type: DetectorModelDefinition structure

Information that defines how a detector operates.

DetectorModelConfiguration

Description

Information about how the detector model is configured.

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

The time the detector model was created.

detectorModelArn
  • Type: string

The ARN of the detector model.

detectorModelDescription
  • Type: string

A brief description of the detector model.

detectorModelName
  • Type: string

The name of the detector model.

detectorModelVersion
  • Type: string

The version of the detector model.

evaluationMethod
  • Type: string

Information about the order in which events are evaluated and how actions are executed.

key
  • Type: string

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

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

The time the detector model was last updated.

roleArn
  • Type: string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

status
  • Type: string

The status of the detector model.

DetectorModelDefinition

Description

Information that defines how a detector operates.

Members
initialStateName
  • Required: Yes
  • Type: string

The state that is entered at the creation of each detector (instance).

states
  • Required: Yes
  • Type: Array of State structures

Information about the states of the detector.

DetectorModelSummary

Description

Information about the detector model.

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

The time the detector model was created.

detectorModelDescription
  • Type: string

A brief description of the detector model.

detectorModelName
  • Type: string

The name of the detector model.

DetectorModelVersionSummary

Description

Information about the detector model version.

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

The time the detector model version was created.

detectorModelArn
  • Type: string

The ARN of the detector model version.

detectorModelName
  • Type: string

The name of the detector model.

detectorModelVersion
  • Type: string

The ID of the detector model version.

evaluationMethod
  • Type: string

Information about the order in which events are evaluated and how actions are executed.

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

The last time the detector model version was updated.

roleArn
  • Type: string

The ARN of the role that grants the detector model permission to perform its tasks.

status
  • Type: string

The status of the detector model version.

DynamoDBAction

Description

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the hashKeyValue parameter uses a substitution template.

    '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the tableName parameter uses a string concatenation.

    'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw.

Members
hashKeyField
  • Required: Yes
  • Type: string

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

hashKeyType
  • Type: string

The data type for the hash key (also called the partition key). You can specify the following values:

  • 'STRING' - The hash key is a string.

  • 'NUMBER' - The hash key is a number.

If you don't specify hashKeyType, the default value is 'STRING'.

hashKeyValue
  • Required: Yes
  • Type: string

The value of the hash key (also called the partition key).

operation
  • Type: string

The type of operation to perform. You can specify the following values:

  • 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.

  • 'UPDATE' - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.

  • 'DELETE' - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.

If you don't specify this parameter, AWS IoT Events triggers the 'INSERT' operation.

payload
  • Type: Payload structure

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

payloadField
  • Type: string

The name of the DynamoDB column that receives the action payload.

If you don't specify this parameter, the name of the DynamoDB column is payload.

rangeKeyField
  • Type: string

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

rangeKeyType
  • Type: string

The data type for the range key (also called the sort key), You can specify the following values:

  • 'STRING' - The range key is a string.

  • 'NUMBER' - The range key is number.

If you don't specify rangeKeyField, the default value is 'STRING'.

rangeKeyValue
  • Type: string

The value of the range key (also called the sort key).

tableName
  • Required: Yes
  • Type: string

The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.

DynamoDBv2Action

Description

Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable'.

  • For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

    '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the tableName parameter uses a string concatenation.

    'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide.

The value for the type parameter in Payload must be JSON.

Members
payload
  • Type: Payload structure

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

tableName
  • Required: Yes
  • Type: string

The name of the DynamoDB table.

Event

Description

Specifies the actions to be performed when the condition evaluates to TRUE.

Members
actions
  • Type: Array of Action structures

The actions to be performed.

condition
  • Type: string

Optional. The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

eventName
  • Required: Yes
  • Type: string

The name of the event.

FirehoseAction

Description

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Members
deliveryStreamName
  • Required: Yes
  • Type: string

The name of the Kinesis Data Firehose delivery stream where the data is written.

payload
  • Type: Payload structure

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

separator
  • Type: string

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

Input

Description

Information about the input.

Members
inputConfiguration
  • Type: InputConfiguration structure

Information about the configuration of an input.

inputDefinition
  • Type: InputDefinition structure

The definition of the input.

InputConfiguration

Description

Information about the configuration of an input.

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

The time the input was created.

inputArn
  • Required: Yes
  • Type: string

The ARN of the input.

inputDescription
  • Type: string

A brief description of the input.

inputName
  • Required: Yes
  • Type: string

The name of the input.

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

The last time the input was updated.

status
  • Required: Yes
  • Type: string

The status of the input.

InputDefinition

Description

The definition of the input.

Members
attributes
  • Required: Yes
  • Type: Array of Attribute structures

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors that monitor this input.

InputSummary

Description

Information about the input.

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

The time the input was created.

inputArn
  • Type: string

The ARN of the input.

inputDescription
  • Type: string

A brief description of the input.

inputName
  • Type: string

The name of the input.

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

The last time the input was updated.

status
  • Type: string

The status of the input.

InternalFailureException

Description

An internal failure occurred.

Members
message
  • Type: string

The message for the exception.

InvalidRequestException

Description

The request was invalid.

Members
message
  • Type: string

The message for the exception.

IotEventsAction

Description

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

Members
inputName
  • Required: Yes
  • Type: string

The name of the AWS IoT Events input where the data is sent.

payload
  • Type: Payload structure

You can configure the action payload when you send a message to an AWS IoT Events input.

IotSiteWiseAction

Description

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.

You must use expressions for all parameters in IotSiteWiseAction. The expressions accept literals, operators, functions, references, and substitutions templates.

Examples

  • For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature'.

  • For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the propertyAlias parameter uses a substitution template.

    'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise.

For more information, see Expressions in the AWS IoT Events Developer Guide.

Members
assetId
  • Type: string

The ID of the asset that has the specified property.

entryId
  • Type: string

A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

propertyAlias
  • Type: string

The alias of the asset property.

propertyId
  • Type: string

The ID of the asset property.

propertyValue
  • Required: Yes
  • Type: AssetPropertyValue structure

The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

IotTopicPublishAction

Description

Information required to publish the MQTT message through the AWS IoT message broker.

Members
mqttTopic
  • Required: Yes
  • Type: string

The MQTT topic of the message. You can use a string expression that includes variables ($variable.<variable-name>) and input values ($input.<input-name>.<path-to-datum>) as the topic string.

payload
  • Type: Payload structure

You can configure the action payload when you publish a message to an AWS IoT Core topic.

LambdaAction

Description

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

Members
functionArn
  • Required: Yes
  • Type: string

The ARN of the Lambda function that is executed.

payload
  • Type: Payload structure

You can configure the action payload when you send a message to a Lambda function.

LimitExceededException

Description

A limit was exceeded.

Members
message
  • Type: string

The message for the exception.

LoggingOptions

Description

The values of the AWS IoT Events logging options.

Members
detectorDebugOptions
  • Type: Array of DetectorDebugOption structures

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

enabled
  • Required: Yes
  • Type: boolean

If TRUE, logging is enabled for AWS IoT Events.

level
  • Required: Yes
  • Type: string

The logging level.

roleArn
  • Required: Yes
  • Type: string

The ARN of the role that grants permission to AWS IoT Events to perform logging.

OnEnterLifecycle

Description

When entering this state, perform these actions if the condition is TRUE.

Members
events
  • Type: Array of Event structures

Specifies the actions that are performed when the state is entered and the condition is TRUE.

OnExitLifecycle

Description

When exiting this state, perform these actions if the specified condition is TRUE.

Members
events
  • Type: Array of Event structures

Specifies the actions that are performed when the state is exited and the condition is TRUE.

OnInputLifecycle

Description

Specifies the actions performed when the condition evaluates to TRUE.

Members
events
  • Type: Array of Event structures

Specifies the actions performed when the condition evaluates to TRUE.

transitionEvents
  • Type: Array of TransitionEvent structures

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

Payload

Description

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

Members
contentExpression
  • Required: Yes
  • Type: string

The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

type
  • Required: Yes
  • Type: string

The value of the payload type can be either STRING or JSON.

ResetTimerAction

Description

Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when you reset the timer.

Members
timerName
  • Required: Yes
  • Type: string

The name of the timer to reset.

ResourceAlreadyExistsException

Description

The resource already exists.

Members
message
  • Type: string

The message for the exception.

resourceArn
  • Type: string

The ARN of the resource.

resourceId
  • Type: string

The ID of the resource.

ResourceInUseException

Description

The resource is in use.

Members
message
  • Type: string

The message for the exception.

ResourceNotFoundException

Description

The resource was not found.

Members
message
  • Type: string

The message for the exception.

SNSTopicPublishAction

Description

Information required to publish the Amazon SNS message.

Members
payload
  • Type: Payload structure

You can configure the action payload when you send a message as an Amazon SNS push notification.

targetArn
  • Required: Yes
  • Type: string

The ARN of the Amazon SNS target where the message is sent.

ServiceUnavailableException

Description

The service is currently unavailable.

Members
message
  • Type: string

The message for the exception.

SetTimerAction

Description

Information needed to set the timer.

Members
durationExpression
  • Type: string

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

seconds
  • Type: int

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

timerName
  • Required: Yes
  • Type: string

The name of the timer.

SetVariableAction

Description

Information about the variable and its new value.

Members
value
  • Required: Yes
  • Type: string

The new value of the variable.

variableName
  • Required: Yes
  • Type: string

The name of the variable.

SqsAction

Description

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Members
payload
  • Type: Payload structure

You can configure the action payload when you send a message to an Amazon SQS queue.

queueUrl
  • Required: Yes
  • Type: string

The URL of the SQS queue where the data is written.

useBase64
  • Type: boolean

Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.

State

Description

Information that defines a state of a detector.

Members
onEnter
  • Type: OnEnterLifecycle structure

When entering this state, perform these actions if the condition is TRUE.

onExit
  • Type: OnExitLifecycle structure

When exiting this state, perform these actions if the specified condition is TRUE.

onInput
  • Type: OnInputLifecycle structure

When an input is received and the condition is TRUE, perform the specified actions.

stateName
  • Required: Yes
  • Type: string

The name of the state.

Tag

Description

Metadata that can be used to manage the resource.

Members
key
  • Required: Yes
  • Type: string

The tag's key.

value
  • Required: Yes
  • Type: string

The tag's value.

ThrottlingException

Description

The request could not be completed due to throttling.

Members
message
  • Type: string

The message for the exception.

TransitionEvent

Description

Specifies the actions performed and the next state entered when a condition evaluates to TRUE.

Members
actions
  • Type: Array of Action structures

The actions to be performed.

condition
  • Required: Yes
  • Type: string

Required. A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

eventName
  • Required: Yes
  • Type: string

The name of the transition event.

nextState
  • Required: Yes
  • Type: string

The next state to enter.

UnsupportedOperationException

Description

The requested operation is not supported.

Members
message
  • Type: string

The message for the exception.

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