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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AWS IoT Things Graph 2018-09-06

Client: Aws\IoTThingsGraph\IoTThingsGraphClient
Service ID: iotthingsgraph
Version: 2018-09-06

This page describes the parameters and results for the operations of the AWS IoT Things Graph (2018-09-06), and shows how to use the Aws\IoTThingsGraph\IoTThingsGraphClient object to call the described operations. This documentation is specific to the 2018-09-06 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 */).

  • AssociateEntityToThing ( array $params = [] )

    Associates a device with a concrete thing that is in the user's registry.

  • CreateFlowTemplate ( array $params = [] )

    Creates a workflow template.

  • CreateSystemInstance ( array $params = [] )

    Creates a system instance.

  • CreateSystemTemplate ( array $params = [] )

    Creates a system.

  • DeleteFlowTemplate ( array $params = [] )

    Deletes a workflow.

  • DeleteNamespace ( array $params = [] )

    Deletes the specified namespace.

  • DeleteSystemInstance ( array $params = [] )

    Deletes a system instance.

  • DeleteSystemTemplate ( array $params = [] )

    Deletes a system.

  • DeploySystemInstance ( array $params = [] )

    Greengrass and Cloud Deployments Deploys the system instance to the target specified in CreateSystemInstance.

  • DeprecateFlowTemplate ( array $params = [] )

    Deprecates the specified workflow.

  • DeprecateSystemTemplate ( array $params = [] )

    Deprecates the specified system.

  • DescribeNamespace ( array $params = [] )

    Gets the latest version of the user's namespace and the public version that it is tracking.

  • DissociateEntityFromThing ( array $params = [] )

    Dissociates a device entity from a concrete thing.

  • GetEntities ( array $params = [] )

    Gets definitions of the specified entities.

  • GetFlowTemplate ( array $params = [] )

    Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

  • GetFlowTemplateRevisions ( array $params = [] )

    Gets revisions of the specified workflow.

  • GetNamespaceDeletionStatus ( array $params = [] )

    Gets the status of a namespace deletion task.

  • GetSystemInstance ( array $params = [] )

    Gets a system instance.

  • GetSystemTemplate ( array $params = [] )

    Gets a system.

  • GetSystemTemplateRevisions ( array $params = [] )

    Gets revisions made to the specified system template.

  • GetUploadStatus ( array $params = [] )

    Gets the status of the specified upload.

  • ListFlowExecutionMessages ( array $params = [] )

    Returns a list of objects that contain information about events in a flow execution.

  • ListTagsForResource ( array $params = [] )

    Lists all tags on an AWS IoT Things Graph resource.

  • SearchEntities ( array $params = [] )

    Searches for entities of the specified type.

  • SearchFlowExecutions ( array $params = [] )

    Searches for AWS IoT Things Graph workflow execution instances.

  • SearchFlowTemplates ( array $params = [] )

    Searches for summary information about workflows.

  • SearchSystemInstances ( array $params = [] )

    Searches for system instances in the user's account.

  • SearchSystemTemplates ( array $params = [] )

    Searches for summary information about systems in the user's account.

  • SearchThings ( array $params = [] )

    Searches for things associated with the specified entity.

  • TagResource ( array $params = [] )

    Creates a tag for the specified resource.

  • UndeploySystemInstance ( array $params = [] )

    Removes a system instance from its target (Cloud or Greengrass).

  • UntagResource ( array $params = [] )

    Removes a tag from the specified resource.

  • UpdateFlowTemplate ( array $params = [] )

    Updates the specified workflow.

  • UpdateSystemTemplate ( array $params = [] )

    Updates the specified system.

  • UploadEntityDefinitions ( array $params = [] )

    Asynchronously uploads one or more entity definitions to the user's namespace.

Paginators

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

  • GetFlowTemplateRevisions
  • GetSystemTemplateRevisions
  • ListFlowExecutionMessages
  • ListTagsForResource
  • SearchEntities
  • SearchFlowExecutions
  • SearchFlowTemplates
  • SearchSystemInstances
  • SearchSystemTemplates
  • SearchThings

Operations

AssociateEntityToThing

$result = $client->associateEntityToThing([/* ... */]);
$promise = $client->associateEntityToThingAsync([/* ... */]);

Associates a device with a concrete thing that is in the user's registry.

A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

Parameter Syntax

$result = $client->associateEntityToThing([
    'entityId' => '<string>', // REQUIRED
    'namespaceVersion' => <integer>,
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Members
entityId
  • Required: Yes
  • Type: string

The ID of the device to be associated with the thing.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

thingName
  • Required: Yes
  • Type: string

The name of the thing to which the entity is to be associated.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • InternalFailureException:

  • ThrottlingException:

CreateFlowTemplate

$result = $client->createFlowTemplate([/* ... */]);
$promise = $client->createFlowTemplateAsync([/* ... */]);

Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

Parameter Syntax

$result = $client->createFlowTemplate([
    'compatibleNamespaceVersion' => <integer>,
    'definition' => [ // REQUIRED
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
compatibleNamespaceVersion
  • Type: long (int|float)

The namespace version in which the workflow is to be created.

If no value is specified, the latest version is used by default.

definition
  • Required: Yes
  • Type: DefinitionDocument structure

The workflow DefinitionDocument.

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Members
summary
  • Type: FlowTemplateSummary structure

The summary object that describes the created workflow.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • LimitExceededException:

  • InternalFailureException:

CreateSystemInstance

$result = $client->createSystemInstance([/* ... */]);
$promise = $client->createSystemInstanceAsync([/* ... */]);

Creates a system instance.

This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

Parameter Syntax

$result = $client->createSystemInstance([
    'definition' => [ // REQUIRED
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'flowActionsRoleArn' => '<string>',
    'greengrassGroupName' => '<string>',
    'metricsConfiguration' => [
        'cloudMetricEnabled' => true || false,
        'metricRuleRoleArn' => '<string>',
    ],
    's3BucketName' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'target' => 'GREENGRASS|CLOUD', // REQUIRED
]);

Parameter Details

Members
definition
  • Required: Yes
  • Type: DefinitionDocument structure

A document that defines an entity.

flowActionsRoleArn
  • Type: string

The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.

greengrassGroupName
  • Type: string

The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

metricsConfiguration
  • Type: MetricsConfiguration structure

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

s3BucketName
  • Type: string

The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.

tags
  • Type: Array of Tag structures

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

target
  • Required: Yes
  • Type: string

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'greengrassGroupId' => '<string>',
        'greengrassGroupName' => '<string>',
        'greengrassGroupVersionId' => '<string>',
        'id' => '<string>',
        'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
        'target' => 'GREENGRASS|CLOUD',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
summary
  • Type: SystemInstanceSummary structure

The summary object that describes the new system instance.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • InternalFailureException:

  • LimitExceededException:

CreateSystemTemplate

$result = $client->createSystemTemplate([/* ... */]);
$promise = $client->createSystemTemplateAsync([/* ... */]);

Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

Parameter Syntax

$result = $client->createSystemTemplate([
    'compatibleNamespaceVersion' => <integer>,
    'definition' => [ // REQUIRED
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members
compatibleNamespaceVersion
  • Type: long (int|float)

The namespace version in which the system is to be created.

If no value is specified, the latest version is used by default.

definition
  • Required: Yes
  • Type: DefinitionDocument structure

The DefinitionDocument used to create the system.

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Members
summary
  • Type: SystemTemplateSummary structure

The summary object that describes the created system.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • InternalFailureException:

DeleteFlowTemplate

$result = $client->deleteFlowTemplate([/* ... */]);
$promise = $client->deleteFlowTemplateAsync([/* ... */]);

Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the workflow to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceInUseException:

DeleteNamespace

$result = $client->deleteNamespace([/* ... */]);
$promise = $client->deleteNamespaceAsync([/* ... */]);

Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
]

Result Details

Members
namespaceArn
  • Type: string

The ARN of the namespace to be deleted.

namespaceName
  • Type: string

The name of the namespace to be deleted.

Errors

  • InternalFailureException:

  • ThrottlingException:

DeleteSystemInstance

$result = $client->deleteSystemInstance([/* ... */]);
$promise = $client->deleteSystemInstanceAsync([/* ... */]);

Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.

Users can create a new system instance that has the same ID as a deleted system instance.

Parameter Syntax

$result = $client->deleteSystemInstance([
    'id' => '<string>',
]);

Parameter Details

Members
id
  • Type: string

The ID of the system instance to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceInUseException:

DeleteSystemTemplate

$result = $client->deleteSystemTemplate([/* ... */]);
$promise = $client->deleteSystemTemplateAsync([/* ... */]);

Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the system to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceInUseException:

DeploySystemInstance

$result = $client->deploySystemInstance([/* ... */]);
$promise = $client->deploySystemInstanceAsync([/* ... */]);

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Greengrass Deployments

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

Parameter Syntax

$result = $client->deploySystemInstance([
    'id' => '<string>',
]);

Parameter Details

Members
id
  • Type: string

The ID of the system instance. This value is returned by the CreateSystemInstance action.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

Result Syntax

[
    'greengrassDeploymentId' => '<string>',
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'greengrassGroupId' => '<string>',
        'greengrassGroupName' => '<string>',
        'greengrassGroupVersionId' => '<string>',
        'id' => '<string>',
        'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
        'target' => 'GREENGRASS|CLOUD',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
greengrassDeploymentId
  • Type: string

The ID of the Greengrass deployment used to deploy the system instance.

summary
  • Required: Yes
  • Type: SystemInstanceSummary structure

An object that contains summary information about a system instance that was deployed.

Errors

  • ResourceNotFoundException:

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceInUseException:

DeprecateFlowTemplate

$result = $client->deprecateFlowTemplate([/* ... */]);
$promise = $client->deprecateFlowTemplateAsync([/* ... */]);

Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the workflow to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

DeprecateSystemTemplate

$result = $client->deprecateSystemTemplate([/* ... */]);
$promise = $client->deprecateSystemTemplateAsync([/* ... */]);

Deprecates the specified system.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the system to delete.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

DescribeNamespace

$result = $client->describeNamespace([/* ... */]);
$promise = $client->describeNamespaceAsync([/* ... */]);

Gets the latest version of the user's namespace and the public version that it is tracking.

Parameter Syntax

$result = $client->describeNamespace([
    'namespaceName' => '<string>',
]);

Parameter Details

Members
namespaceName
  • Type: string

The name of the user's namespace. Set this to aws to get the public namespace.

Result Syntax

[
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'namespaceVersion' => <integer>,
    'trackingNamespaceName' => '<string>',
    'trackingNamespaceVersion' => <integer>,
]

Result Details

Members
namespaceArn
  • Type: string

The ARN of the namespace.

namespaceName
  • Type: string

The name of the namespace.

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace to describe.

trackingNamespaceName
  • Type: string

The name of the public namespace that the latest namespace version is tracking.

trackingNamespaceVersion
  • Type: long (int|float)

The version of the public namespace that the latest version is tracking.

Errors

  • ResourceNotFoundException:

  • InvalidRequestException:

  • InternalFailureException:

  • ThrottlingException:

DissociateEntityFromThing

$result = $client->dissociateEntityFromThing([/* ... */]);
$promise = $client->dissociateEntityFromThingAsync([/* ... */]);

Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.

Parameter Syntax

$result = $client->dissociateEntityFromThing([
    'entityType' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM', // REQUIRED
    'thingName' => '<string>', // REQUIRED
]);

Parameter Details

Members
entityType
  • Required: Yes
  • Type: string

The entity type from which to disassociate the thing.

thingName
  • Required: Yes
  • Type: string

The name of the thing to disassociate.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • InternalFailureException:

  • ThrottlingException:

GetEntities

$result = $client->getEntities([/* ... */]);
$promise = $client->getEntitiesAsync([/* ... */]);

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

  • Properties

  • States

  • Events

  • Actions

  • Capabilities

  • Mappings

  • Devices

  • Device Models

  • Services

This action doesn't return definitions for systems, flows, and deployments.

Parameter Syntax

$result = $client->getEntities([
    'ids' => ['<string>', ...], // REQUIRED
    'namespaceVersion' => <integer>,
]);

Parameter Details

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

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Result Syntax

[
    'descriptions' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'definition' => [
                'language' => 'GRAPHQL',
                'text' => '<string>',
            ],
            'id' => '<string>',
            'type' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM',
        ],
        // ...
    ],
]

Result Details

Members
descriptions
  • Type: Array of EntityDescription structures

An array of descriptions for the specified entities.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • ThrottlingException:

  • InternalFailureException:

GetFlowTemplate

$result = $client->getFlowTemplate([/* ... */]);
$promise = $client->getFlowTemplateAsync([/* ... */]);

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

Parameter Syntax

$result = $client->getFlowTemplate([
    'id' => '<string>', // REQUIRED
    'revisionNumber' => <integer>,
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the workflow.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

revisionNumber
  • Type: long (int|float)

The number of the workflow revision to retrieve.

Result Syntax

[
    'description' => [
        'definition' => [
            'language' => 'GRAPHQL',
            'text' => '<string>',
        ],
        'summary' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        'validatedNamespaceVersion' => <integer>,
    ],
]

Result Details

Members
description
  • Type: FlowTemplateDescription structure

The object that describes the specified workflow.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

GetFlowTemplateRevisions

$result = $client->getFlowTemplateRevisions([/* ... */]);
$promise = $client->getFlowTemplateRevisionsAsync([/* ... */]);

Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the workflow.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of FlowTemplateSummary structures

An array of objects that provide summary data about each revision.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

GetNamespaceDeletionStatus

$result = $client->getNamespaceDeletionStatus([/* ... */]);
$promise = $client->getNamespaceDeletionStatusAsync([/* ... */]);

Gets the status of a namespace deletion task.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

[
    'errorCode' => 'VALIDATION_FAILED',
    'errorMessage' => '<string>',
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'status' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]

Result Details

Members
errorCode
  • Type: string

An error code returned by the namespace deletion task.

errorMessage
  • Type: string

An error code returned by the namespace deletion task.

namespaceArn
  • Type: string

The ARN of the namespace that is being deleted.

namespaceName
  • Type: string

The name of the namespace that is being deleted.

status
  • Type: string

The status of the deletion request.

Errors

  • InvalidRequestException:

  • InternalFailureException:

  • ThrottlingException:

GetSystemInstance

$result = $client->getSystemInstance([/* ... */]);
$promise = $client->getSystemInstanceAsync([/* ... */]);

Gets a system instance.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the system deployment instance. This value is returned by CreateSystemInstance.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

Result Syntax

[
    'description' => [
        'definition' => [
            'language' => 'GRAPHQL',
            'text' => '<string>',
        ],
        'flowActionsRoleArn' => '<string>',
        'metricsConfiguration' => [
            'cloudMetricEnabled' => true || false,
            'metricRuleRoleArn' => '<string>',
        ],
        's3BucketName' => '<string>',
        'summary' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'greengrassGroupId' => '<string>',
            'greengrassGroupName' => '<string>',
            'greengrassGroupVersionId' => '<string>',
            'id' => '<string>',
            'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
            'target' => 'GREENGRASS|CLOUD',
            'updatedAt' => <DateTime>,
        ],
        'validatedDependencyRevisions' => [
            [
                'id' => '<string>',
                'revisionNumber' => <integer>,
            ],
            // ...
        ],
        'validatedNamespaceVersion' => <integer>,
    ],
]

Result Details

Members
description
  • Type: SystemInstanceDescription structure

An object that describes the system instance.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

GetSystemTemplate

$result = $client->getSystemTemplate([/* ... */]);
$promise = $client->getSystemTemplateAsync([/* ... */]);

Gets a system.

Parameter Syntax

$result = $client->getSystemTemplate([
    'id' => '<string>', // REQUIRED
    'revisionNumber' => <integer>,
]);

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the system to get. This ID must be in the user's namespace.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

revisionNumber
  • Type: long (int|float)

The number that specifies the revision of the system to get.

Result Syntax

[
    'description' => [
        'definition' => [
            'language' => 'GRAPHQL',
            'text' => '<string>',
        ],
        'summary' => [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        'validatedNamespaceVersion' => <integer>,
    ],
]

Result Details

Members
description
  • Type: SystemTemplateDescription structure

An object that contains summary data about the system.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

GetSystemTemplateRevisions

$result = $client->getSystemTemplateRevisions([/* ... */]);
$promise = $client->getSystemTemplateRevisionsAsync([/* ... */]);

Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.

Parameter Syntax

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

Parameter Details

Members
id
  • Required: Yes
  • Type: string

The ID of the system template.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of SystemTemplateSummary structures

An array of objects that contain summary data about the system template revisions.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

GetUploadStatus

$result = $client->getUploadStatus([/* ... */]);
$promise = $client->getUploadStatusAsync([/* ... */]);

Gets the status of the specified upload.

Parameter Syntax

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

Parameter Details

Members
uploadId
  • Required: Yes
  • Type: string

The ID of the upload. This value is returned by the UploadEntityDefinitions action.

Result Syntax

[
    'createdDate' => <DateTime>,
    'failureReason' => ['<string>', ...],
    'namespaceArn' => '<string>',
    'namespaceName' => '<string>',
    'namespaceVersion' => <integer>,
    'uploadId' => '<string>',
    'uploadStatus' => 'IN_PROGRESS|SUCCEEDED|FAILED',
]

Result Details

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

The date at which the upload was created.

failureReason
  • Type: Array of strings

The reason for an upload failure.

namespaceArn
  • Type: string

The ARN of the upload.

namespaceName
  • Type: string

The name of the upload's namespace.

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

uploadId
  • Required: Yes
  • Type: string

The ID of the upload.

uploadStatus
  • Required: Yes
  • Type: string

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • InternalFailureException:

  • ThrottlingException:

ListFlowExecutionMessages

$result = $client->listFlowExecutionMessages([/* ... */]);
$promise = $client->listFlowExecutionMessagesAsync([/* ... */]);

Returns a list of objects that contain information about events in a flow execution.

Parameter Syntax

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

Parameter Details

Members
flowExecutionId
  • Required: Yes
  • Type: string

The ID of the flow execution.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'messages' => [
        [
            'eventType' => 'EXECUTION_STARTED|EXECUTION_FAILED|EXECUTION_ABORTED|EXECUTION_SUCCEEDED|STEP_STARTED|STEP_FAILED|STEP_SUCCEEDED|ACTIVITY_SCHEDULED|ACTIVITY_STARTED|ACTIVITY_FAILED|ACTIVITY_SUCCEEDED|START_FLOW_EXECUTION_TASK|SCHEDULE_NEXT_READY_STEPS_TASK|THING_ACTION_TASK|THING_ACTION_TASK_FAILED|THING_ACTION_TASK_SUCCEEDED|ACKNOWLEDGE_TASK_MESSAGE',
            'messageId' => '<string>',
            'payload' => '<string>',
            'timestamp' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
messages
  • Type: Array of FlowExecutionMessage structures

A list of objects that contain information about events in the specified flow execution.

nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

ListTagsForResource

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

Lists all tags on an AWS IoT Things Graph resource.

Parameter Syntax

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

Parameter Details

Members
maxResults
  • Type: int

The maximum number of tags to return.

nextToken
  • Type: string

The token that specifies the next page of results to return.

resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource whose tags are to be returned.

Result Syntax

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

Result Details

Members
nextToken
  • Type: string

The token that specifies the next page of results to return.

tags
  • Type: Array of Tag structures

List of tags returned by the ListTagsForResource operation.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • InternalFailureException:

SearchEntities

$result = $client->searchEntities([/* ... */]);
$promise = $client->searchEntitiesAsync([/* ... */]);

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

Parameter Syntax

$result = $client->searchEntities([
    'entityTypes' => ['<string>', ...], // REQUIRED
    'filters' => [
        [
            'name' => 'NAME|NAMESPACE|SEMANTIC_TYPE_PATH|REFERENCED_ENTITY_ID',
            'value' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'namespaceVersion' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

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

The entity types for which to search.

filters
  • Type: Array of EntityFilter structures

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

maxResults
  • Type: int

The maximum number of results to return in the response.

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'descriptions' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'definition' => [
                'language' => 'GRAPHQL',
                'text' => '<string>',
            ],
            'id' => '<string>',
            'type' => 'DEVICE|SERVICE|DEVICE_MODEL|CAPABILITY|STATE|ACTION|EVENT|PROPERTY|MAPPING|ENUM',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
descriptions
  • Type: Array of EntityDescription structures

An array of descriptions for each entity returned in the search result.

nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

Errors

  • InvalidRequestException:

  • InternalFailureException:

  • ThrottlingException:

SearchFlowExecutions

$result = $client->searchFlowExecutions([/* ... */]);
$promise = $client->searchFlowExecutionsAsync([/* ... */]);

Searches for AWS IoT Things Graph workflow execution instances.

Parameter Syntax

$result = $client->searchFlowExecutions([
    'endTime' => <integer || string || DateTime>,
    'flowExecutionId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'startTime' => <integer || string || DateTime>,
    'systemInstanceId' => '<string>', // REQUIRED
]);

Parameter Details

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

The date and time of the latest flow execution to return.

flowExecutionId
  • Type: string

The ID of a flow execution.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

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

The date and time of the earliest flow execution to return.

systemInstanceId
  • Required: Yes
  • Type: string

The ID of the system instance that contains the flow.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'createdAt' => <DateTime>,
            'flowExecutionId' => '<string>',
            'flowTemplateId' => '<string>',
            'status' => 'RUNNING|ABORTED|SUCCEEDED|FAILED',
            'systemInstanceId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of FlowExecutionSummary structures

An array of objects that contain summary information about each workflow execution in the result set.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

SearchFlowTemplates

$result = $client->searchFlowTemplates([/* ... */]);
$promise = $client->searchFlowTemplatesAsync([/* ... */]);

Searches for summary information about workflows.

Parameter Syntax

$result = $client->searchFlowTemplates([
    'filters' => [
        [
            'name' => 'DEVICE_MODEL_ID', // REQUIRED
            'value' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Array of FlowTemplateFilter structures

An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of FlowTemplateSummary structures

An array of objects that contain summary information about each workflow in the result set.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

SearchSystemInstances

$result = $client->searchSystemInstances([/* ... */]);
$promise = $client->searchSystemInstancesAsync([/* ... */]);

Searches for system instances in the user's account.

Parameter Syntax

$result = $client->searchSystemInstances([
    'filters' => [
        [
            'name' => 'SYSTEM_TEMPLATE_ID|STATUS|GREENGRASS_GROUP_NAME',
            'value' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Array of SystemInstanceFilter structures

Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'greengrassGroupId' => '<string>',
            'greengrassGroupName' => '<string>',
            'greengrassGroupVersionId' => '<string>',
            'id' => '<string>',
            'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
            'target' => 'GREENGRASS|CLOUD',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of SystemInstanceSummary structures

An array of objects that contain summary data abour the system instances in the result set.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

SearchSystemTemplates

$result = $client->searchSystemTemplates([/* ... */]);
$promise = $client->searchSystemTemplatesAsync([/* ... */]);

Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

Parameter Syntax

$result = $client->searchSystemTemplates([
    'filters' => [
        [
            'name' => 'FLOW_TEMPLATE_ID', // REQUIRED
            'value' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Array of SystemTemplateFilter structures

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

maxResults
  • Type: int

The maximum number of results to return in the response.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'summaries' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'id' => '<string>',
            'revisionNumber' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

summaries
  • Type: Array of SystemTemplateSummary structures

An array of objects that contain summary information about each system deployment in the result set.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

SearchThings

$result = $client->searchThings([/* ... */]);
$promise = $client->searchThingsAsync([/* ... */]);

Searches for things associated with the specified entity. You can search by both device and device model.

For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

This action searches for exact matches and doesn't perform partial text matching.

Parameter Syntax

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

Parameter Details

Members
entityId
  • Required: Yes
  • Type: string

The ID of the entity to which the things are associated.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

maxResults
  • Type: int

The maximum number of results to return in the response.

namespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

nextToken
  • Type: string

The string that specifies the next page of results. Use this when you're paginating results.

Result Syntax

[
    'nextToken' => '<string>',
    'things' => [
        [
            'thingArn' => '<string>',
            'thingName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The string to specify as nextToken when you request the next page of results.

things
  • Type: Array of Thing structures

An array of things in the result set.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • InternalFailureException:

  • ThrottlingException:

TagResource

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

Creates a tag for the specified 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 Amazon Resource Name (ARN) of the resource whose tags are returned.

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

A list of tags to add to the resource.>

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • InternalFailureException:

UndeploySystemInstance

$result = $client->undeploySystemInstance([/* ... */]);
$promise = $client->undeploySystemInstanceAsync([/* ... */]);

Removes a system instance from its target (Cloud or Greengrass).

Parameter Syntax

$result = $client->undeploySystemInstance([
    'id' => '<string>',
]);

Parameter Details

Members
id
  • Type: string

The ID of the system instance to remove from its target.

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'greengrassGroupId' => '<string>',
        'greengrassGroupName' => '<string>',
        'greengrassGroupVersionId' => '<string>',
        'id' => '<string>',
        'status' => 'NOT_DEPLOYED|BOOTSTRAP|DEPLOY_IN_PROGRESS|DEPLOYED_IN_TARGET|UNDEPLOY_IN_PROGRESS|FAILED|PENDING_DELETE|DELETED_IN_TARGET',
        'target' => 'GREENGRASS|CLOUD',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
summary
  • Type: SystemInstanceSummary structure

An object that contains summary information about the system instance that was removed from its target.

Errors

  • InvalidRequestException:

  • ThrottlingException:

  • InternalFailureException:

  • ResourceNotFoundException:

  • ResourceInUseException:

UntagResource

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

Removes a tag from the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource whose tags are to be removed.

tagKeys
  • Required: Yes
  • Type: Array of strings

A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.

This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • InvalidRequestException:

  • ResourceAlreadyExistsException:

  • ThrottlingException:

  • InternalFailureException:

UpdateFlowTemplate

$result = $client->updateFlowTemplate([/* ... */]);
$promise = $client->updateFlowTemplateAsync([/* ... */]);

Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

Parameter Syntax

$result = $client->updateFlowTemplate([
    'compatibleNamespaceVersion' => <integer>,
    'definition' => [ // REQUIRED
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
compatibleNamespaceVersion
  • Type: long (int|float)

The version of the user's namespace.

If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

definition
  • Required: Yes
  • Type: DefinitionDocument structure

The DefinitionDocument that contains the updated workflow definition.

id
  • Required: Yes
  • Type: string

The ID of the workflow to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Members
summary
  • Type: FlowTemplateSummary structure

An object containing summary information about the updated workflow.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • ThrottlingException:

  • InternalFailureException:

UpdateSystemTemplate

$result = $client->updateSystemTemplate([/* ... */]);
$promise = $client->updateSystemTemplateAsync([/* ... */]);

Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

Parameter Syntax

$result = $client->updateSystemTemplate([
    'compatibleNamespaceVersion' => <integer>,
    'definition' => [ // REQUIRED
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'id' => '<string>', // REQUIRED
]);

Parameter Details

Members
compatibleNamespaceVersion
  • Type: long (int|float)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

If no value is specified, the latest version is used by default.

definition
  • Required: Yes
  • Type: DefinitionDocument structure

The DefinitionDocument that contains the updated system definition.

id
  • Required: Yes
  • Type: string

The ID of the system to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

Result Syntax

[
    'summary' => [
        'arn' => '<string>',
        'createdAt' => <DateTime>,
        'id' => '<string>',
        'revisionNumber' => <integer>,
    ],
]

Result Details

Members
summary
  • Type: SystemTemplateSummary structure

An object containing summary information about the updated system.

Errors

  • InvalidRequestException:

  • ResourceNotFoundException:

  • ThrottlingException:

  • InternalFailureException:

UploadEntityDefinitions

$result = $client->uploadEntityDefinitions([/* ... */]);
$promise = $client->uploadEntityDefinitionsAsync([/* ... */]);

Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

Parameter Syntax

$result = $client->uploadEntityDefinitions([
    'deprecateExistingEntities' => true || false,
    'document' => [
        'language' => 'GRAPHQL', // REQUIRED
        'text' => '<string>', // REQUIRED
    ],
    'syncWithPublicNamespace' => true || false,
]);

Parameter Details

Members
deprecateExistingEntities
  • Type: boolean

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

document
  • Type: DefinitionDocument structure

The DefinitionDocument that defines the updated entities.

syncWithPublicNamespace
  • Type: boolean

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

Result Syntax

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

Result Details

Members
uploadId
  • Required: Yes
  • Type: string

The ID that specifies the upload action. You can use this to track the status of the upload.

Errors

  • InvalidRequestException:

  • InternalFailureException:

  • ThrottlingException:

Shapes

DefinitionDocument

Description

A document that defines an entity.

Members
language
  • Required: Yes
  • Type: string

The language used to define the entity. GRAPHQL is the only valid value.

text
  • Required: Yes
  • Type: string

The GraphQL text that defines the entity.

DependencyRevision

Description

An object that contains the ID and revision number of a workflow or system that is part of a deployment.

Members
id
  • Type: string

The ID of the workflow or system.

revisionNumber
  • Type: long (int|float)

The revision number of the workflow or system.

EntityDescription

Description

Describes the properties of an entity.

Members
arn
  • Type: string

The entity ARN.

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

The time at which the entity was created.

definition
  • Type: DefinitionDocument structure

The definition document of the entity.

id
  • Type: string

The entity ID.

type
  • Type: string

The entity type.

EntityFilter

Description

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

Members
name
  • Type: string

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

value
  • Type: Array of strings

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

FlowExecutionMessage

Description

An object that contains information about a flow event.

Members
eventType
  • Type: string

The type of flow event .

messageId
  • Type: string

The unique identifier of the message.

payload
  • Type: string

A string containing information about the flow event.

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

The date and time when the message was last updated.

FlowExecutionSummary

Description

An object that contains summary information about a flow execution.

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

The date and time when the flow execution summary was created.

flowExecutionId
  • Type: string

The ID of the flow execution.

flowTemplateId
  • Type: string

The ID of the flow.

status
  • Type: string

The current status of the flow execution.

systemInstanceId
  • Type: string

The ID of the system instance that contains the flow.

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

The date and time when the flow execution summary was last updated.

FlowTemplateDescription

Description

An object that contains a workflow's definition and summary information.

Members
definition
  • Type: DefinitionDocument structure

A workflow's definition document.

summary
  • Type: FlowTemplateSummary structure

An object that contains summary information about a workflow.

validatedNamespaceVersion
  • Type: long (int|float)

The version of the user's namespace against which the workflow was validated. Use this value in your system instance.

FlowTemplateFilter

Description

An object that filters a workflow search.

Members
name
  • Required: Yes
  • Type: string

The name of the search filter field.

value
  • Required: Yes
  • Type: Array of strings

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

FlowTemplateSummary

Description

An object that contains summary information about a workflow.

Members
arn
  • Type: string

The ARN of the workflow.

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

The date when the workflow was created.

id
  • Type: string

The ID of the workflow.

revisionNumber
  • Type: long (int|float)

The revision number of the workflow.

InternalFailureException

Description

Members
message
  • Type: string

InvalidRequestException

Description

Members
message
  • Type: string

LimitExceededException

Description

Members
message
  • Type: string

MetricsConfiguration

Description

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

Members
cloudMetricEnabled
  • Type: boolean

A Boolean that specifies whether cloud metrics are collected.

metricRuleRoleArn
  • Type: string

The ARN of the role that is used to collect cloud metrics.

ResourceAlreadyExistsException

Description

Members
message
  • Type: string

ResourceInUseException

Description

Members
message
  • Type: string

ResourceNotFoundException

Description

Members
message
  • Type: string

SystemInstanceDescription

Description

An object that contains a system instance definition and summary information.

Members
definition
  • Type: DefinitionDocument structure

A document that defines an entity.

flowActionsRoleArn
  • Type: string

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

metricsConfiguration
  • Type: MetricsConfiguration structure

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

s3BucketName
  • Type: string

The Amazon Simple Storage Service bucket where information about a system instance is stored.

summary
  • Type: SystemInstanceSummary structure

An object that contains summary information about a system instance.

validatedDependencyRevisions
  • Type: Array of DependencyRevision structures

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

validatedNamespaceVersion
  • Type: long (int|float)

The version of the user's namespace against which the system instance was validated.

SystemInstanceFilter

Description

An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.

Members
name
  • Type: string

The name of the search filter field.

value
  • Type: Array of strings

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

SystemInstanceSummary

Description

An object that contains summary information about a system instance.

Members
arn
  • Type: string

The ARN of the system instance.

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

The date when the system instance was created.

greengrassGroupId
  • Type: string

The ID of the Greengrass group where the system instance is deployed.

greengrassGroupName
  • Type: string

The ID of the Greengrass group where the system instance is deployed.

greengrassGroupVersionId
  • Type: string

The version of the Greengrass group where the system instance is deployed.

id
  • Type: string

The ID of the system instance.

status
  • Type: string

The status of the system instance.

target
  • Type: string

The target of the system instance.

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

The date and time when the system instance was last updated.

SystemTemplateDescription

Description

An object that contains a system's definition document and summary information.

Members
definition
  • Type: DefinitionDocument structure

The definition document of a system.

summary
  • Type: SystemTemplateSummary structure

An object that contains summary information about a system.

validatedNamespaceVersion
  • Type: long (int|float)

The namespace version against which the system was validated. Use this value in your system instance.

SystemTemplateFilter

Description

An object that filters a system search.

Members
name
  • Required: Yes
  • Type: string

The name of the system search filter field.

value
  • Required: Yes
  • Type: Array of strings

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

SystemTemplateSummary

Description

An object that contains information about a system.

Members
arn
  • Type: string

The ARN of the system.

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

The date when the system was created.

id
  • Type: string

The ID of the system.

revisionNumber
  • Type: long (int|float)

The revision number of the system.

Tag

Description

Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

Members
key
  • Required: Yes
  • Type: string

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

value
  • Required: Yes
  • Type: string

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

Thing

Description

An AWS IoT thing.

Members
thingArn
  • Type: string

The ARN of the thing.

thingName
  • Type: string

The name of the thing.

ThrottlingException

Description

Members
message
  • Type: string
AWS SDK for PHP 3.x API documentation generated by ApiGen