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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • 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
    • ConnectCampaignService
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • drs
      • 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
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • 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
    • Inspector2
      • 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
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • 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
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • 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
    • Script
      • Composer
    • 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
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • 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
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • 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\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • 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\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • 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\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • 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\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • 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\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • 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\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • 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\Inspector2\Inspector2Client
  • 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\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • 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\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • 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\NimbleStudio\NimbleStudioClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • 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\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • 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\S3\ValidateResponseChecksumParser
  • 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\Script\Composer\Composer
  • 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\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • 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\VoiceID\VoiceIDClient
  • 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\WorkSpacesWeb\WorkSpacesWebClient
  • 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\DefaultsMode\ConfigurationInterface
  • Aws\DynamoDb\SessionConnectionInterface
  • Aws\Endpoint\PartitionInterface
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationInterface
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationInterface
  • 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\CalculatesChecksumTrait
  • 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\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • 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\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • 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\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • 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\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • 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\DefaultsMode\Exception\ConfigurationException
  • 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\drs\Exception\drsException
  • 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\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • 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\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • 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\Inspector2\Exception\Inspector2Exception
  • 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\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • 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\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • 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\NimbleStudio\Exception\NimbleStudioException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • 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\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • 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\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • 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\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • 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\VoiceID\Exception\VoiceIDException
  • 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\WorkSpacesWeb\Exception\WorkSpacesWebException
  • 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_fips_pseudo_region
  • 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\strip_fips_pseudo_regions

AWS Panorama 2019-07-24

Client: Aws\Panorama\PanoramaClient
Service ID: panorama
Version: 2019-07-24

This page describes the parameters and results for the operations of the AWS Panorama (2019-07-24), and shows how to use the Aws\Panorama\PanoramaClient object to call the described operations. This documentation is specific to the 2019-07-24 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 */).

  • CreateApplicationInstance ( array $params = [] )

    Creates an application instance and deploys it to a device.

  • CreateJobForDevices ( array $params = [] )

    Creates a job to run on one or more devices.

  • CreateNodeFromTemplateJob ( array $params = [] )

    Creates a camera stream node.

  • CreatePackage ( array $params = [] )

    Creates a package and storage location in an Amazon S3 access point.

  • CreatePackageImportJob ( array $params = [] )

    Imports a node package.

  • DeleteDevice ( array $params = [] )

    Deletes a device.

  • DeletePackage ( array $params = [] )

    Deletes a package.

  • DeregisterPackageVersion ( array $params = [] )

    Deregisters a package version.

  • DescribeApplicationInstance ( array $params = [] )

    Returns information about an application instance on a device.

  • DescribeApplicationInstanceDetails ( array $params = [] )

    Returns information about an application instance's configuration manifest.

  • DescribeDevice ( array $params = [] )

    Returns information about a device.

  • DescribeDeviceJob ( array $params = [] )

    Returns information about a device job.

  • DescribeNode ( array $params = [] )

    Returns information about a node.

  • DescribeNodeFromTemplateJob ( array $params = [] )

    Returns information about a job to create a camera stream node.

  • DescribePackage ( array $params = [] )

    Returns information about a package.

  • DescribePackageImportJob ( array $params = [] )

    Returns information about a package import job.

  • DescribePackageVersion ( array $params = [] )

    Returns information about a package version.

  • ListApplicationInstanceDependencies ( array $params = [] )

    Returns a list of application instance dependencies.

  • ListApplicationInstanceNodeInstances ( array $params = [] )

    Returns a list of application node instances.

  • ListApplicationInstances ( array $params = [] )

    Returns a list of application instances.

  • ListDevices ( array $params = [] )

    Returns a list of devices.

  • ListDevicesJobs ( array $params = [] )

    Returns a list of jobs.

  • ListNodeFromTemplateJobs ( array $params = [] )

    Returns a list of camera stream node jobs.

  • ListNodes ( array $params = [] )

    Returns a list of nodes.

  • ListPackageImportJobs ( array $params = [] )

    Returns a list of package import jobs.

  • ListPackages ( array $params = [] )

    Returns a list of packages.

  • ListTagsForResource ( array $params = [] )

    Returns a list of tags for a resource.

  • ProvisionDevice ( array $params = [] )

    Creates a device and returns a configuration archive.

  • RegisterPackageVersion ( array $params = [] )

    Registers a package version.

  • RemoveApplicationInstance ( array $params = [] )

    Removes an application instance.

  • TagResource ( array $params = [] )

    Tags a resource.

  • UntagResource ( array $params = [] )

    Removes tags from a resource.

  • UpdateDeviceMetadata ( array $params = [] )

    Updates a device's metadata.

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:

  • ListApplicationInstanceDependencies
  • ListApplicationInstanceNodeInstances
  • ListApplicationInstances
  • ListDevices
  • ListDevicesJobs
  • ListNodeFromTemplateJobs
  • ListNodes
  • ListPackageImportJobs
  • ListPackages

Operations

CreateApplicationInstance

$result = $client->createApplicationInstance([/* ... */]);
$promise = $client->createApplicationInstanceAsync([/* ... */]);

Creates an application instance and deploys it to a device.

Parameter Syntax

$result = $client->createApplicationInstance([
    'ApplicationInstanceIdToReplace' => '<string>',
    'DefaultRuntimeContextDevice' => '<string>', // REQUIRED
    'Description' => '<string>',
    'ManifestOverridesPayload' => [
        'PayloadData' => '<string>',
    ],
    'ManifestPayload' => [ // REQUIRED
        'PayloadData' => '<string>',
    ],
    'Name' => '<string>',
    'RuntimeRoleArn' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationInstanceIdToReplace
  • Type: string

The ID of an application instance to replace with the new instance.

DefaultRuntimeContextDevice
  • Required: Yes
  • Type: string

A device's ID.

Description
  • Type: string

A description for the application instance.

ManifestOverridesPayload
  • Type: ManifestOverridesPayload structure

Setting overrides for the application manifest.

ManifestPayload
  • Required: Yes
  • Type: ManifestPayload structure

The application's manifest document.

Name
  • Type: string

A name for the application instance.

RuntimeRoleArn
  • Type: string

The ARN of a runtime role for the application instance.

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

Tags for the application instance.

Result Syntax

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

Result Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

The application instance's ID.

Errors

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ServiceQuotaExceededException:

    The request would cause a limit to be exceeded.

  • InternalServerException:

    An internal error occurred.

CreateJobForDevices

$result = $client->createJobForDevices([/* ... */]);
$promise = $client->createJobForDevicesAsync([/* ... */]);

Creates a job to run on one or more devices.

Parameter Syntax

$result = $client->createJobForDevices([
    'DeviceIds' => ['<string>', ...], // REQUIRED
    'DeviceJobConfig' => [ // REQUIRED
        'OTAJobConfig' => [
            'ImageVersion' => '<string>', // REQUIRED
        ],
    ],
    'JobType' => 'OTA', // REQUIRED
]);

Parameter Details

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

IDs of target devices.

DeviceJobConfig
  • Required: Yes
  • Type: DeviceJobConfig structure

Configuration settings for the job.

JobType
  • Required: Yes
  • Type: string

The type of job to run.

Result Syntax

[
    'Jobs' => [
        [
            'DeviceId' => '<string>',
            'JobId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Jobs
  • Required: Yes
  • Type: Array of Job structures

A list of jobs.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

CreateNodeFromTemplateJob

$result = $client->createNodeFromTemplateJob([/* ... */]);
$promise = $client->createNodeFromTemplateJobAsync([/* ... */]);

Creates a camera stream node.

Parameter Syntax

$result = $client->createNodeFromTemplateJob([
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE', // REQUIRED
            'Tags' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'NodeDescription' => '<string>',
    'NodeName' => '<string>', // REQUIRED
    'OutputPackageName' => '<string>', // REQUIRED
    'OutputPackageVersion' => '<string>', // REQUIRED
    'TemplateParameters' => ['<string>', ...], // REQUIRED
    'TemplateType' => 'RTSP_CAMERA_STREAM', // REQUIRED
]);

Parameter Details

Members
JobTags
  • Type: Array of JobResourceTags structures

Tags for the job.

NodeDescription
  • Type: string

A description for the node.

NodeName
  • Required: Yes
  • Type: string

A name for the node.

OutputPackageName
  • Required: Yes
  • Type: string

An output package name for the node.

OutputPackageVersion
  • Required: Yes
  • Type: string

An output package version for the node.

TemplateParameters
  • Required: Yes
  • Type: Associative array of custom strings keys (TemplateKey) to strings

Template parameters for the node.

TemplateType
  • Required: Yes
  • Type: string

The type of node.

Result Syntax

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

Result Details

Members
JobId
  • Required: Yes
  • Type: string

The job's ID.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

CreatePackage

$result = $client->createPackage([/* ... */]);
$promise = $client->createPackageAsync([/* ... */]);

Creates a package and storage location in an Amazon S3 access point.

Parameter Syntax

$result = $client->createPackage([
    'PackageName' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
PackageName
  • Required: Yes
  • Type: string

A name for the package.

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

Tags for the package.

Result Syntax

[
    'Arn' => '<string>',
    'PackageId' => '<string>',
    'StorageLocation' => [
        'BinaryPrefixLocation' => '<string>',
        'Bucket' => '<string>',
        'GeneratedPrefixLocation' => '<string>',
        'ManifestPrefixLocation' => '<string>',
        'RepoPrefixLocation' => '<string>',
    ],
]

Result Details

Members
Arn
  • Type: string

The package's ARN.

PackageId
  • Type: string

The package's ID.

StorageLocation
  • Required: Yes
  • Type: StorageLocation structure

The package's storage location.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

CreatePackageImportJob

$result = $client->createPackageImportJob([/* ... */]);
$promise = $client->createPackageImportJobAsync([/* ... */]);

Imports a node package.

Parameter Syntax

$result = $client->createPackageImportJob([
    'ClientToken' => '<string>', // REQUIRED
    'InputConfig' => [ // REQUIRED
        'PackageVersionInputConfig' => [
            'S3Location' => [ // REQUIRED
                'BucketName' => '<string>', // REQUIRED
                'ObjectKey' => '<string>', // REQUIRED
                'Region' => '<string>',
            ],
        ],
    ],
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE', // REQUIRED
            'Tags' => ['<string>', ...], // REQUIRED
        ],
        // ...
    ],
    'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION', // REQUIRED
    'OutputConfig' => [ // REQUIRED
        'PackageVersionOutputConfig' => [
            'MarkLatest' => true || false,
            'PackageName' => '<string>', // REQUIRED
            'PackageVersion' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members
ClientToken
  • Required: Yes
  • Type: string

A client token for the package import job.

InputConfig
  • Required: Yes
  • Type: PackageImportJobInputConfig structure

An input config for the package import job.

JobTags
  • Type: Array of JobResourceTags structures

Tags for the package import job.

JobType
  • Required: Yes
  • Type: string

A job type for the package import job.

OutputConfig
  • Required: Yes
  • Type: PackageImportJobOutputConfig structure

An output config for the package import job.

Result Syntax

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

Result Details

Members
JobId
  • Required: Yes
  • Type: string

The job's ID.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

DeleteDevice

$result = $client->deleteDevice([/* ... */]);
$promise = $client->deleteDeviceAsync([/* ... */]);

Deletes a device.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The device's ID.

Result Syntax

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

Result Details

Members
DeviceId
  • Type: string

The device's ID.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DeletePackage

$result = $client->deletePackage([/* ... */]);
$promise = $client->deletePackageAsync([/* ... */]);

Deletes a package.

To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.

Parameter Syntax

$result = $client->deletePackage([
    'ForceDelete' => true || false,
    'PackageId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ForceDelete
  • Type: boolean

Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

PackageId
  • Required: Yes
  • Type: string

The package's ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DeregisterPackageVersion

$result = $client->deregisterPackageVersion([/* ... */]);
$promise = $client->deregisterPackageVersionAsync([/* ... */]);

Deregisters a package version.

Parameter Syntax

$result = $client->deregisterPackageVersion([
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>', // REQUIRED
    'UpdatedLatestPatchVersion' => '<string>',
]);

Parameter Details

Members
OwnerAccount
  • Type: string

An owner account.

PackageId
  • Required: Yes
  • Type: string

A package ID.

PackageVersion
  • Required: Yes
  • Type: string

A package version.

PatchVersion
  • Required: Yes
  • Type: string

A patch version.

UpdatedLatestPatchVersion
  • Type: string

If the version was marked latest, the new version to maker as latest.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeApplicationInstance

$result = $client->describeApplicationInstance([/* ... */]);
$promise = $client->describeApplicationInstanceAsync([/* ... */]);

Returns information about an application instance on a device.

Parameter Syntax

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

Parameter Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

The application instance's ID.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
    'ApplicationInstanceIdToReplace' => '<string>',
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'DefaultRuntimeContextDevice' => '<string>',
    'DefaultRuntimeContextDeviceName' => '<string>',
    'Description' => '<string>',
    'HealthStatus' => 'RUNNING|ERROR|NOT_AVAILABLE',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'RuntimeRoleArn' => '<string>',
    'Status' => 'DEPLOYMENT_PENDING|DEPLOYMENT_REQUESTED|DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_ERROR|DEPLOYMENT_SUCCEEDED|REMOVAL_PENDING|REMOVAL_REQUESTED|REMOVAL_IN_PROGRESS|REMOVAL_FAILED|REMOVAL_SUCCEEDED|DEPLOYMENT_FAILED',
    'StatusDescription' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
ApplicationInstanceId
  • Type: string

The application instance's ID.

ApplicationInstanceIdToReplace
  • Type: string

The ID of the application instance that this instance replaced.

Arn
  • Type: string

The application instance's ARN.

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

When the application instance was created.

DefaultRuntimeContextDevice
  • Type: string

The device's ID.

DefaultRuntimeContextDeviceName
  • Type: string

The device's bane.

Description
  • Type: string

The application instance's description.

HealthStatus
  • Type: string

The application instance's health status.

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

The application instance was updated.

Name
  • Type: string

The application instance's name.

RuntimeRoleArn
  • Type: string

The application instance's runtime role ARN.

Status
  • Type: string

The application instance's status.

StatusDescription
  • Type: string

The application instance's status description.

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

The application instance's tags.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeApplicationInstanceDetails

$result = $client->describeApplicationInstanceDetails([/* ... */]);
$promise = $client->describeApplicationInstanceDetailsAsync([/* ... */]);

Returns information about an application instance's configuration manifest.

Parameter Syntax

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

Parameter Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

The application instance's ID.

Result Syntax

[
    'ApplicationInstanceId' => '<string>',
    'ApplicationInstanceIdToReplace' => '<string>',
    'CreatedTime' => <DateTime>,
    'DefaultRuntimeContextDevice' => '<string>',
    'Description' => '<string>',
    'ManifestOverridesPayload' => [
        'PayloadData' => '<string>',
    ],
    'ManifestPayload' => [
        'PayloadData' => '<string>',
    ],
    'Name' => '<string>',
]

Result Details

Members
ApplicationInstanceId
  • Type: string

The application instance's ID.

ApplicationInstanceIdToReplace
  • Type: string

The ID of the application instance that this instance replaced.

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

When the application instance was created.

DefaultRuntimeContextDevice
  • Type: string

The application instance's default runtime context device.

Description
  • Type: string

The application instance's description.

ManifestOverridesPayload
  • Type: ManifestOverridesPayload structure

Parameter overrides for the configuration manifest.

ManifestPayload
  • Type: ManifestPayload structure

The application instance's configuration manifest.

Name
  • Type: string

The application instance's name.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeDevice

$result = $client->describeDevice([/* ... */]);
$promise = $client->describeDeviceAsync([/* ... */]);

Returns information about a device.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The device's ID.

Result Syntax

[
    'AlternateSoftwares' => [
        [
            'Version' => '<string>',
        ],
        // ...
    ],
    'Arn' => '<string>',
    'Brand' => 'AWS_PANORAMA|LENOVO',
    'CreatedTime' => <DateTime>,
    'CurrentNetworkingStatus' => [
        'Ethernet0Status' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'HwAddress' => '<string>',
            'IpAddress' => '<string>',
        ],
        'Ethernet1Status' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'HwAddress' => '<string>',
            'IpAddress' => '<string>',
        ],
        'LastUpdatedTime' => <DateTime>,
        'NtpStatus' => [
            'ConnectionStatus' => 'CONNECTED|NOT_CONNECTED|CONNECTING',
            'IpAddress' => '<string>',
            'NtpServerName' => '<string>',
        ],
    ],
    'CurrentSoftware' => '<string>',
    'Description' => '<string>',
    'DeviceConnectionStatus' => 'ONLINE|OFFLINE|AWAITING_CREDENTIALS|NOT_AVAILABLE|ERROR',
    'DeviceId' => '<string>',
    'LatestAlternateSoftware' => '<string>',
    'LatestSoftware' => '<string>',
    'LeaseExpirationTime' => <DateTime>,
    'Name' => '<string>',
    'NetworkingConfiguration' => [
        'Ethernet0' => [
            'ConnectionType' => 'STATIC_IP|DHCP',
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>',
                'Dns' => ['<string>', ...],
                'IpAddress' => '<string>',
                'Mask' => '<string>',
            ],
        ],
        'Ethernet1' => [
            'ConnectionType' => 'STATIC_IP|DHCP',
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>',
                'Dns' => ['<string>', ...],
                'IpAddress' => '<string>',
                'Mask' => '<string>',
            ],
        ],
        'Ntp' => [
            'NtpServers' => ['<string>', ...],
        ],
    ],
    'ProvisioningStatus' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
    'SerialNumber' => '<string>',
    'Tags' => ['<string>', ...],
    'Type' => 'PANORAMA_APPLIANCE_DEVELOPER_KIT|PANORAMA_APPLIANCE',
]

Result Details

Members
AlternateSoftwares
  • Type: Array of AlternateSoftwareMetadata structures

Beta software releases available for the device.

Arn
  • Type: string

The device's ARN.

Brand
  • Type: string

The device's maker.

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

When the device was created.

CurrentNetworkingStatus
  • Type: NetworkStatus structure

The device's networking status.

CurrentSoftware
  • Type: string

The device's current software version.

Description
  • Type: string

The device's description.

DeviceConnectionStatus
  • Type: string

The device's connection status.

DeviceId
  • Type: string

The device's ID.

LatestAlternateSoftware
  • Type: string

The most recent beta software release.

LatestSoftware
  • Type: string

The latest software version available for the device.

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

The device's lease expiration time.

Name
  • Type: string

The device's name.

NetworkingConfiguration
  • Type: NetworkPayload structure

The device's networking configuration.

ProvisioningStatus
  • Type: string

The device's provisioning status.

SerialNumber
  • Type: string

The device's serial number.

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

The device's tags.

Type
  • Type: string

The device's type.

Errors

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeDeviceJob

$result = $client->describeDeviceJob([/* ... */]);
$promise = $client->describeDeviceJobAsync([/* ... */]);

Returns information about a device job.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

The job's ID.

Result Syntax

[
    'CreatedTime' => <DateTime>,
    'DeviceArn' => '<string>',
    'DeviceId' => '<string>',
    'DeviceName' => '<string>',
    'DeviceType' => 'PANORAMA_APPLIANCE_DEVELOPER_KIT|PANORAMA_APPLIANCE',
    'ImageVersion' => '<string>',
    'JobId' => '<string>',
    'Status' => 'PENDING|IN_PROGRESS|VERIFYING|REBOOTING|DOWNLOADING|COMPLETED|FAILED',
]

Result Details

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

When the job was created.

DeviceArn
  • Type: string

The device's ARN.

DeviceId
  • Type: string

The device's ID.

DeviceName
  • Type: string

The device's name.

DeviceType
  • Type: string

The device's type.

ImageVersion
  • Type: string

For an OTA job, the target version of the device software.

JobId
  • Type: string

The job's ID.

Status
  • Type: string

The job's status.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeNode

$result = $client->describeNode([/* ... */]);
$promise = $client->describeNodeAsync([/* ... */]);

Returns information about a node.

Parameter Syntax

$result = $client->describeNode([
    'NodeId' => '<string>', // REQUIRED
    'OwnerAccount' => '<string>',
]);

Parameter Details

Members
NodeId
  • Required: Yes
  • Type: string

The node's ID.

OwnerAccount
  • Type: string

The account ID of the node's owner.

Result Syntax

[
    'AssetName' => '<string>',
    'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
    'CreatedTime' => <DateTime>,
    'Description' => '<string>',
    'LastUpdatedTime' => <DateTime>,
    'Name' => '<string>',
    'NodeId' => '<string>',
    'NodeInterface' => [
        'Inputs' => [
            [
                'DefaultValue' => '<string>',
                'Description' => '<string>',
                'MaxConnections' => <integer>,
                'Name' => '<string>',
                'Type' => 'BOOLEAN|STRING|INT32|FLOAT32|MEDIA',
            ],
            // ...
        ],
        'Outputs' => [
            [
                'Description' => '<string>',
                'Name' => '<string>',
                'Type' => 'BOOLEAN|STRING|INT32|FLOAT32|MEDIA',
            ],
            // ...
        ],
    ],
    'OwnerAccount' => '<string>',
    'PackageArn' => '<string>',
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
]

Result Details

Members
AssetName
  • Type: string

The node's asset name.

Category
  • Required: Yes
  • Type: string

The node's category.

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

When the node was created.

Description
  • Required: Yes
  • Type: string

The node's description.

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

When the node was updated.

Name
  • Required: Yes
  • Type: string

The node's name.

NodeId
  • Required: Yes
  • Type: string

The node's ID.

NodeInterface
  • Required: Yes
  • Type: NodeInterface structure

The node's interface.

OwnerAccount
  • Required: Yes
  • Type: string

The account ID of the node's owner.

PackageArn
  • Type: string

The node's ARN.

PackageId
  • Required: Yes
  • Type: string

The node's package ID.

PackageName
  • Required: Yes
  • Type: string

The node's package name.

PackageVersion
  • Required: Yes
  • Type: string

The node's package version.

PatchVersion
  • Required: Yes
  • Type: string

The node's patch version.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribeNodeFromTemplateJob

$result = $client->describeNodeFromTemplateJob([/* ... */]);
$promise = $client->describeNodeFromTemplateJobAsync([/* ... */]);

Returns information about a job to create a camera stream node.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

The job's ID.

Result Syntax

[
    'CreatedTime' => <DateTime>,
    'JobId' => '<string>',
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'LastUpdatedTime' => <DateTime>,
    'NodeDescription' => '<string>',
    'NodeName' => '<string>',
    'OutputPackageName' => '<string>',
    'OutputPackageVersion' => '<string>',
    'Status' => 'PENDING|SUCCEEDED|FAILED',
    'StatusMessage' => '<string>',
    'TemplateParameters' => ['<string>', ...],
    'TemplateType' => 'RTSP_CAMERA_STREAM',
]

Result Details

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

When the job was created.

JobId
  • Required: Yes
  • Type: string

The job's ID.

JobTags
  • Type: Array of JobResourceTags structures

The job's tags.

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

When the job was updated.

NodeDescription
  • Type: string

The node's description.

NodeName
  • Required: Yes
  • Type: string

The node's name.

OutputPackageName
  • Required: Yes
  • Type: string

The job's output package name.

OutputPackageVersion
  • Required: Yes
  • Type: string

The job's output package version.

Status
  • Required: Yes
  • Type: string

The job's status.

StatusMessage
  • Required: Yes
  • Type: string

The job's status message.

TemplateParameters
  • Required: Yes
  • Type: Associative array of custom strings keys (TemplateKey) to strings

The job's template parameters.

TemplateType
  • Required: Yes
  • Type: string

The job's template type.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

DescribePackage

$result = $client->describePackage([/* ... */]);
$promise = $client->describePackageAsync([/* ... */]);

Returns information about a package.

Parameter Syntax

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

Parameter Details

Members
PackageId
  • Required: Yes
  • Type: string

The package's ID.

Result Syntax

[
    'Arn' => '<string>',
    'CreatedTime' => <DateTime>,
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'ReadAccessPrincipalArns' => ['<string>', ...],
    'StorageLocation' => [
        'BinaryPrefixLocation' => '<string>',
        'Bucket' => '<string>',
        'GeneratedPrefixLocation' => '<string>',
        'ManifestPrefixLocation' => '<string>',
        'RepoPrefixLocation' => '<string>',
    ],
    'Tags' => ['<string>', ...],
    'WriteAccessPrincipalArns' => ['<string>', ...],
]

Result Details

Members
Arn
  • Required: Yes
  • Type: string

The package's ARN.

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

When the package was created.

PackageId
  • Required: Yes
  • Type: string

The package's ID.

PackageName
  • Required: Yes
  • Type: string

The package's name.

ReadAccessPrincipalArns
  • Type: Array of strings

ARNs of accounts that have read access to the package.

StorageLocation
  • Required: Yes
  • Type: StorageLocation structure

The package's storage location.

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

The package's tags.

WriteAccessPrincipalArns
  • Type: Array of strings

ARNs of accounts that have write access to the package.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

DescribePackageImportJob

$result = $client->describePackageImportJob([/* ... */]);
$promise = $client->describePackageImportJobAsync([/* ... */]);

Returns information about a package import job.

Parameter Syntax

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

Parameter Details

Members
JobId
  • Required: Yes
  • Type: string

The job's ID.

Result Syntax

[
    'ClientToken' => '<string>',
    'CreatedTime' => <DateTime>,
    'InputConfig' => [
        'PackageVersionInputConfig' => [
            'S3Location' => [
                'BucketName' => '<string>',
                'ObjectKey' => '<string>',
                'Region' => '<string>',
            ],
        ],
    ],
    'JobId' => '<string>',
    'JobTags' => [
        [
            'ResourceType' => 'PACKAGE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION',
    'LastUpdatedTime' => <DateTime>,
    'Output' => [
        'OutputS3Location' => [
            'BucketName' => '<string>',
            'ObjectKey' => '<string>',
        ],
        'PackageId' => '<string>',
        'PackageVersion' => '<string>',
        'PatchVersion' => '<string>',
    ],
    'OutputConfig' => [
        'PackageVersionOutputConfig' => [
            'MarkLatest' => true || false,
            'PackageName' => '<string>',
            'PackageVersion' => '<string>',
        ],
    ],
    'Status' => 'PENDING|SUCCEEDED|FAILED',
    'StatusMessage' => '<string>',
]

Result Details

Members
ClientToken
  • Type: string

The job's client token.

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

When the job was created.

InputConfig
  • Required: Yes
  • Type: PackageImportJobInputConfig structure

The job's input config.

JobId
  • Required: Yes
  • Type: string

The job's ID.

JobTags
  • Type: Array of JobResourceTags structures

The job's tags.

JobType
  • Required: Yes
  • Type: string

The job's type.

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

When the job was updated.

Output
  • Required: Yes
  • Type: PackageImportJobOutput structure

The job's output.

OutputConfig
  • Required: Yes
  • Type: PackageImportJobOutputConfig structure

The job's output config.

Status
  • Required: Yes
  • Type: string

The job's status.

StatusMessage
  • Required: Yes
  • Type: string

The job's status message.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

DescribePackageVersion

$result = $client->describePackageVersion([/* ... */]);
$promise = $client->describePackageVersionAsync([/* ... */]);

Returns information about a package version.

Parameter Syntax

$result = $client->describePackageVersion([
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>',
]);

Parameter Details

Members
OwnerAccount
  • Type: string

The version's owner account.

PackageId
  • Required: Yes
  • Type: string

The version's ID.

PackageVersion
  • Required: Yes
  • Type: string

The version's version.

PatchVersion
  • Type: string

The version's patch version.

Result Syntax

[
    'IsLatestPatch' => true || false,
    'OwnerAccount' => '<string>',
    'PackageArn' => '<string>',
    'PackageId' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
    'RegisteredTime' => <DateTime>,
    'Status' => 'REGISTER_PENDING|REGISTER_COMPLETED|FAILED|DELETING',
    'StatusDescription' => '<string>',
]

Result Details

Members
IsLatestPatch
  • Required: Yes
  • Type: boolean

Whether the version is the latest available.

OwnerAccount
  • Type: string

The account ID of the version's owner.

PackageArn
  • Type: string

The ARN of the package.

PackageId
  • Required: Yes
  • Type: string

The version's ID.

PackageName
  • Required: Yes
  • Type: string

The version's name.

PackageVersion
  • Required: Yes
  • Type: string

The version's version.

PatchVersion
  • Required: Yes
  • Type: string

The version's patch version.

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

The version's registered time.

Status
  • Required: Yes
  • Type: string

The version's status.

StatusDescription
  • Type: string

The version's status description.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

ListApplicationInstanceDependencies

$result = $client->listApplicationInstanceDependencies([/* ... */]);
$promise = $client->listApplicationInstanceDependenciesAsync([/* ... */]);

Returns a list of application instance dependencies.

Parameter Syntax

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

Parameter Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

The application instance's ID.

MaxResults
  • Type: int

The maximum number of application instance dependencies to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageObjects' => [
        [
            'Name' => '<string>',
            'PackageVersion' => '<string>',
            'PatchVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

PackageObjects
  • Type: Array of PackageObject structures

A list of package objects.

Errors

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListApplicationInstanceNodeInstances

$result = $client->listApplicationInstanceNodeInstances([/* ... */]);
$promise = $client->listApplicationInstanceNodeInstancesAsync([/* ... */]);

Returns a list of application node instances.

Parameter Syntax

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

Parameter Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

The node instances' application instance ID.

MaxResults
  • Type: int

The maximum number of node instances to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'NodeInstances' => [
        [
            'CurrentStatus' => 'RUNNING|ERROR|NOT_AVAILABLE',
            'NodeId' => '<string>',
            'NodeInstanceId' => '<string>',
            'NodeName' => '<string>',
            'PackageName' => '<string>',
            'PackagePatchVersion' => '<string>',
            'PackageVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

NodeInstances
  • Type: Array of NodeInstance structures

A list of node instances.

Errors

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListApplicationInstances

$result = $client->listApplicationInstances([/* ... */]);
$promise = $client->listApplicationInstancesAsync([/* ... */]);

Returns a list of application instances.

Parameter Syntax

$result = $client->listApplicationInstances([
    'DeviceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StatusFilter' => 'DEPLOYMENT_SUCCEEDED|DEPLOYMENT_ERROR|REMOVAL_SUCCEEDED|REMOVAL_FAILED|PROCESSING_DEPLOYMENT|PROCESSING_REMOVAL|DEPLOYMENT_FAILED',
]);

Parameter Details

Members
DeviceId
  • Type: string

The application instances' device ID.

MaxResults
  • Type: int

The maximum number of application instances to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

StatusFilter
  • Type: string

Only include instances with a specific status.

Result Syntax

[
    'ApplicationInstances' => [
        [
            'ApplicationInstanceId' => '<string>',
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'DefaultRuntimeContextDevice' => '<string>',
            'DefaultRuntimeContextDeviceName' => '<string>',
            'Description' => '<string>',
            'HealthStatus' => 'RUNNING|ERROR|NOT_AVAILABLE',
            'Name' => '<string>',
            'Status' => 'DEPLOYMENT_PENDING|DEPLOYMENT_REQUESTED|DEPLOYMENT_IN_PROGRESS|DEPLOYMENT_ERROR|DEPLOYMENT_SUCCEEDED|REMOVAL_PENDING|REMOVAL_REQUESTED|REMOVAL_IN_PROGRESS|REMOVAL_FAILED|REMOVAL_SUCCEEDED|DEPLOYMENT_FAILED',
            'StatusDescription' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ApplicationInstances
  • Type: Array of ApplicationInstance structures

A list of application instances.

NextToken
  • Type: string

A pagination token that's included if more results are available.

Errors

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListDevices

$result = $client->listDevices([/* ... */]);
$promise = $client->listDevicesAsync([/* ... */]);

Returns a list of devices.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of devices to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'Devices' => [
        [
            'Brand' => 'AWS_PANORAMA|LENOVO',
            'CreatedTime' => <DateTime>,
            'DeviceId' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'LeaseExpirationTime' => <DateTime>,
            'Name' => '<string>',
            'ProvisioningStatus' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Devices
  • Required: Yes
  • Type: Array of Device structures

A list of devices.

NextToken
  • Type: string

A pagination token that's included if more results are available.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListDevicesJobs

$result = $client->listDevicesJobs([/* ... */]);
$promise = $client->listDevicesJobsAsync([/* ... */]);

Returns a list of jobs.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Type: string

Filter results by the job's target device ID.

MaxResults
  • Type: int

The maximum number of device jobs to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'DeviceJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'DeviceId' => '<string>',
            'DeviceName' => '<string>',
            'JobId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
DeviceJobs
  • Type: Array of DeviceJob structures

A list of jobs.

NextToken
  • Type: string

A pagination token that's included if more results are available.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

ListNodeFromTemplateJobs

$result = $client->listNodeFromTemplateJobs([/* ... */]);
$promise = $client->listNodeFromTemplateJobsAsync([/* ... */]);

Returns a list of camera stream node jobs.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of node from template jobs to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'NodeFromTemplateJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'JobId' => '<string>',
            'NodeName' => '<string>',
            'Status' => 'PENDING|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
            'TemplateType' => 'RTSP_CAMERA_STREAM',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

NodeFromTemplateJobs
  • Required: Yes
  • Type: Array of NodeFromTemplateJob structures

A list of jobs.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListNodes

$result = $client->listNodes([/* ... */]);
$promise = $client->listNodesAsync([/* ... */]);

Returns a list of nodes.

Parameter Syntax

$result = $client->listNodes([
    'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OwnerAccount' => '<string>',
    'PackageName' => '<string>',
    'PackageVersion' => '<string>',
    'PatchVersion' => '<string>',
]);

Parameter Details

Members
Category
  • Type: string

Search for nodes by category.

MaxResults
  • Type: int

The maximum number of nodes to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

OwnerAccount
  • Type: string

Search for nodes by the account ID of the nodes' owner.

PackageName
  • Type: string

Search for nodes by name.

PackageVersion
  • Type: string

Search for nodes by version.

PatchVersion
  • Type: string

Search for nodes by patch version.

Result Syntax

[
    'NextToken' => '<string>',
    'Nodes' => [
        [
            'Category' => 'BUSINESS_LOGIC|ML_MODEL|MEDIA_SOURCE|MEDIA_SINK',
            'CreatedTime' => <DateTime>,
            'Description' => '<string>',
            'Name' => '<string>',
            'NodeId' => '<string>',
            'OwnerAccount' => '<string>',
            'PackageArn' => '<string>',
            'PackageId' => '<string>',
            'PackageName' => '<string>',
            'PackageVersion' => '<string>',
            'PatchVersion' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

Nodes
  • Type: Array of Node structures

A list of nodes.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • InternalServerException:

    An internal error occurred.

ListPackageImportJobs

$result = $client->listPackageImportJobs([/* ... */]);
$promise = $client->listPackageImportJobsAsync([/* ... */]);

Returns a list of package import jobs.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of package import jobs to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'PackageImportJobs' => [
        [
            'CreatedTime' => <DateTime>,
            'JobId' => '<string>',
            'JobType' => 'NODE_PACKAGE_VERSION|MARKETPLACE_NODE_PACKAGE_VERSION',
            'LastUpdatedTime' => <DateTime>,
            'Status' => 'PENDING|SUCCEEDED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

PackageImportJobs
  • Required: Yes
  • Type: Array of PackageImportJob structures

A list of package import jobs.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

ListPackages

$result = $client->listPackages([/* ... */]);
$promise = $client->listPackagesAsync([/* ... */]);

Returns a list of packages.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of packages to return in one page of results.

NextToken
  • Type: string

Specify the pagination token from a previous request to retrieve the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Packages' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
            'PackageId' => '<string>',
            'PackageName' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

A pagination token that's included if more results are available.

Packages
  • Type: Array of PackageListItem structures

A list of packages.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

ListTagsForResource

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

Returns a list of tags for a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The resource's ARN.

Result Syntax

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

Result Details

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

A list of tags.

Errors

  • ValidationException:

    The request contains an invalid parameter value.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

ProvisionDevice

$result = $client->provisionDevice([/* ... */]);
$promise = $client->provisionDeviceAsync([/* ... */]);

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

Parameter Syntax

$result = $client->provisionDevice([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'NetworkingConfiguration' => [
        'Ethernet0' => [
            'ConnectionType' => 'STATIC_IP|DHCP', // REQUIRED
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>', // REQUIRED
                'Dns' => ['<string>', ...], // REQUIRED
                'IpAddress' => '<string>', // REQUIRED
                'Mask' => '<string>', // REQUIRED
            ],
        ],
        'Ethernet1' => [
            'ConnectionType' => 'STATIC_IP|DHCP', // REQUIRED
            'StaticIpConnectionInfo' => [
                'DefaultGateway' => '<string>', // REQUIRED
                'Dns' => ['<string>', ...], // REQUIRED
                'IpAddress' => '<string>', // REQUIRED
                'Mask' => '<string>', // REQUIRED
            ],
        ],
        'Ntp' => [
            'NtpServers' => ['<string>', ...], // REQUIRED
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
Description
  • Type: string

A description for the device.

Name
  • Required: Yes
  • Type: string

A name for the device.

NetworkingConfiguration
  • Type: NetworkPayload structure

A networking configuration for the device.

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

Tags for the device.

Result Syntax

[
    'Arn' => '<string>',
    'Certificates' => <string || resource || Psr\Http\Message\StreamInterface>,
    'DeviceId' => '<string>',
    'IotThingName' => '<string>',
    'Status' => 'AWAITING_PROVISIONING|PENDING|SUCCEEDED|FAILED|ERROR|DELETING',
]

Result Details

Members
Arn
  • Required: Yes
  • Type: string

The device's ARN.

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

The device's configuration bundle.

DeviceId
  • Type: string

The device's ID.

IotThingName
  • Type: string

The device's IoT thing name.

Status
  • Required: Yes
  • Type: string

The device's status.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ServiceQuotaExceededException:

    The request would cause a limit to be exceeded.

  • InternalServerException:

    An internal error occurred.

RegisterPackageVersion

$result = $client->registerPackageVersion([/* ... */]);
$promise = $client->registerPackageVersionAsync([/* ... */]);

Registers a package version.

Parameter Syntax

$result = $client->registerPackageVersion([
    'MarkLatest' => true || false,
    'OwnerAccount' => '<string>',
    'PackageId' => '<string>', // REQUIRED
    'PackageVersion' => '<string>', // REQUIRED
    'PatchVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members
MarkLatest
  • Type: boolean

Whether to mark the new version as the latest version.

OwnerAccount
  • Type: string

An owner account.

PackageId
  • Required: Yes
  • Type: string

A package ID.

PackageVersion
  • Required: Yes
  • Type: string

A package version.

PatchVersion
  • Required: Yes
  • Type: string

A patch version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • InternalServerException:

    An internal error occurred.

RemoveApplicationInstance

$result = $client->removeApplicationInstance([/* ... */]);
$promise = $client->removeApplicationInstanceAsync([/* ... */]);

Removes an application instance.

Parameter Syntax

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

Parameter Details

Members
ApplicationInstanceId
  • Required: Yes
  • Type: string

An application instance ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

TagResource

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

Tags a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The resource's ARN.

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

Tags for the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request contains an invalid parameter value.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

UntagResource

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

Removes tags from a resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The resource's ARN.

TagKeys
  • Required: Yes
  • Type: Array of strings

Tag keys to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The request contains an invalid parameter value.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

UpdateDeviceMetadata

$result = $client->updateDeviceMetadata([/* ... */]);
$promise = $client->updateDeviceMetadataAsync([/* ... */]);

Updates a device's metadata.

Parameter Syntax

$result = $client->updateDeviceMetadata([
    'Description' => '<string>',
    'DeviceId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string

A description for the device.

DeviceId
  • Required: Yes
  • Type: string

The device's ID.

Result Syntax

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

Result Details

Members
DeviceId
  • Type: string

The device's ID.

Errors

  • ConflictException:

    The target resource is in use.

  • ValidationException:

    The request contains an invalid parameter value.

  • AccessDeniedException:

    The requestor does not have permission to access the target action or resource.

  • ResourceNotFoundException:

    The target resource was not found.

  • InternalServerException:

    An internal error occurred.

Shapes

AccessDeniedException

Description

The requestor does not have permission to access the target action or resource.

Members
Message
  • Required: Yes
  • Type: string

AlternateSoftwareMetadata

Description

Details about a beta appliance software update.

Members
Version
  • Type: string

The appliance software version.

ApplicationInstance

Description

An application instance on a device.

Members
ApplicationInstanceId
  • Type: string

The application instance's ID.

Arn
  • Type: string

The application instance's ARN.

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

When the application instance was created.

DefaultRuntimeContextDevice
  • Type: string

The device's ID.

DefaultRuntimeContextDeviceName
  • Type: string

The device's name.

Description
  • Type: string

The application instance's description.

HealthStatus
  • Type: string

The application instance's health status.

Name
  • Type: string

The application instance's name.

Status
  • Type: string

The application instance's status.

StatusDescription
  • Type: string

The application instance's status description.

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

The application instance's tags.

ConflictException

Description

The target resource is in use.

Members
ErrorArguments
  • Type: Array of ConflictExceptionErrorArgument structures

A list of attributes that led to the exception and their values.

ErrorId
  • Type: string

A unique ID for the error.

Message
  • Required: Yes
  • Type: string
ResourceId
  • Required: Yes
  • Type: string

The resource's ID.

ResourceType
  • Required: Yes
  • Type: string

The resource's type.

ConflictExceptionErrorArgument

Description

A conflict exception error argument.

Members
Name
  • Required: Yes
  • Type: string

The error argument's name.

Value
  • Required: Yes
  • Type: string

The error argument's value.

Device

Description

A device.

Members
Brand
  • Type: string

The device's maker.

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

When the device was created.

DeviceId
  • Type: string

The device's ID.

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

When the device was updated.

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

The device's lease expiration time.

Name
  • Type: string

The device's name.

ProvisioningStatus
  • Type: string

The device's provisioning status.

DeviceJob

Description

A job that runs on a device.

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

When the job was created.

DeviceId
  • Type: string

The ID of the target device.

DeviceName
  • Type: string

The name of the target device

JobId
  • Type: string

The job's ID.

DeviceJobConfig

Description

A job's configuration.

Members
OTAJobConfig
  • Type: OTAJobConfig structure

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

EthernetPayload

Description

A device's network configuration.

Members
ConnectionType
  • Required: Yes
  • Type: string

How the device gets an IP address.

StaticIpConnectionInfo
  • Type: StaticIpConnectionInfo structure

Network configuration for a static IP connection.

EthernetStatus

Description

A device's Ethernet status.

Members
ConnectionStatus
  • Type: string

The device's connection status.

HwAddress
  • Type: string

The device's physical address.

IpAddress
  • Type: string

The device's IP address.

InternalServerException

Description

An internal error occurred.

Members
Message
  • Required: Yes
  • Type: string
RetryAfterSeconds
  • Type: int

The number of seconds a client should wait before retrying the call.

Job

Description

A job for a device.

Members
DeviceId
  • Type: string

The target device's ID.

JobId
  • Type: string

The job's ID.

JobResourceTags

Description

Tags for a job.

Members
ResourceType
  • Required: Yes
  • Type: string

The job's type.

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

The job's tags.

ManifestOverridesPayload

Description

Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document.

Members
PayloadData
  • Type: string

The overrides document.

ManifestPayload

Description

A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source.

Members
PayloadData
  • Type: string

The application manifest.

NetworkPayload

Description

The network configuration for a device.

Members
Ethernet0
  • Type: EthernetPayload structure

Settings for Ethernet port 0.

Ethernet1
  • Type: EthernetPayload structure

Settings for Ethernet port 1.

Ntp
  • Type: NtpPayload structure

Network time protocol (NTP) server settings.

NetworkStatus

Description

The network status of a device.

Members
Ethernet0Status
  • Type: EthernetStatus structure

The status of Ethernet port 0.

Ethernet1Status
  • Type: EthernetStatus structure

The status of Ethernet port 1.

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

When the network status changed.

NtpStatus
  • Type: NtpStatus structure

Details about a network time protocol (NTP) server connection.

Node

Description

An application node that represents a camera stream, a model, code, or output.

Members
Category
  • Required: Yes
  • Type: string

The node's category.

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

When the node was created.

Description
  • Type: string

The node's description.

Name
  • Required: Yes
  • Type: string

The node's name.

NodeId
  • Required: Yes
  • Type: string

The node's ID.

OwnerAccount
  • Type: string

The account ID of the node's owner.

PackageArn
  • Type: string

The node's ARN.

PackageId
  • Required: Yes
  • Type: string

The node's package ID.

PackageName
  • Required: Yes
  • Type: string

The node's package name.

PackageVersion
  • Required: Yes
  • Type: string

The node's package version.

PatchVersion
  • Required: Yes
  • Type: string

The node's patch version.

NodeFromTemplateJob

Description

A job to create a camera stream node.

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

When the job was created.

JobId
  • Type: string

The job's ID.

NodeName
  • Type: string

The node's name.

Status
  • Type: string

The job's status.

StatusMessage
  • Type: string

The job's status message.

TemplateType
  • Type: string

The job's template type.

NodeInputPort

Description

A node input port.

Members
DefaultValue
  • Type: string

The input port's default value.

Description
  • Type: string

The input port's description.

MaxConnections
  • Type: int

The input port's max connections.

Name
  • Type: string

The input port's name.

Type
  • Type: string

The input port's type.

NodeInstance

Description

A node instance.

Members
CurrentStatus
  • Required: Yes
  • Type: string

The instance's current status.

NodeId
  • Type: string

The node's ID.

NodeInstanceId
  • Required: Yes
  • Type: string

The instance's ID.

NodeName
  • Type: string

The instance's name.

PackageName
  • Type: string

The instance's package name.

PackagePatchVersion
  • Type: string

The instance's package patch version.

PackageVersion
  • Type: string

The instance's package version.

NodeInterface

Description

A node interface.

Members
Inputs
  • Required: Yes
  • Type: Array of NodeInputPort structures

The node interface's inputs.

Outputs
  • Required: Yes
  • Type: Array of NodeOutputPort structures

The node interface's outputs.

NodeOutputPort

Description

A node output port.

Members
Description
  • Type: string

The output port's description.

Name
  • Type: string

The output port's name.

Type
  • Type: string

The output port's type.

NtpPayload

Description

Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of pool.ntp.org.

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

NTP servers to use, in order of preference.

NtpStatus

Description

Details about an NTP server connection.

Members
ConnectionStatus
  • Type: string

The connection's status.

IpAddress
  • Type: string

The IP address of the server.

NtpServerName
  • Type: string

The domain name of the server.

OTAJobConfig

Description

An over-the-air update (OTA) job configuration.

Members
ImageVersion
  • Required: Yes
  • Type: string

The target version of the device software.

OutPutS3Location

Description

The location of an output object in Amazon S3.

Members
BucketName
  • Required: Yes
  • Type: string

The object's bucket.

ObjectKey
  • Required: Yes
  • Type: string

The object's key.

PackageImportJob

Description

A job to import a package version.

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

When the job was created.

JobId
  • Type: string

The job's ID.

JobType
  • Type: string

The job's type.

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

When the job was updated.

Status
  • Type: string

The job's status.

StatusMessage
  • Type: string

The job's status message.

PackageImportJobInputConfig

Description

A configuration for a package import job.

Members
PackageVersionInputConfig
  • Type: PackageVersionInputConfig structure

The package version's input configuration.

PackageImportJobOutput

Description

Results of a package import job.

Members
OutputS3Location
  • Required: Yes
  • Type: OutPutS3Location structure

The package's output location.

PackageId
  • Required: Yes
  • Type: string

The package's ID.

PackageVersion
  • Required: Yes
  • Type: string

The package's version.

PatchVersion
  • Required: Yes
  • Type: string

The package's patch version.

PackageImportJobOutputConfig

Description

An output configuration for a package import job.

Members
PackageVersionOutputConfig
  • Type: PackageVersionOutputConfig structure

The package version's output configuration.

PackageListItem

Description

A package summary.

Members
Arn
  • Type: string

The package's ARN.

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

When the package was created.

PackageId
  • Type: string

The package's ID.

PackageName
  • Type: string

The package's name.

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

The package's tags.

PackageObject

Description

A package object.

Members
Name
  • Required: Yes
  • Type: string

The object's name.

PackageVersion
  • Required: Yes
  • Type: string

The object's package version.

PatchVersion
  • Required: Yes
  • Type: string

The object's patch version.

PackageVersionInputConfig

Description

A package version input configuration.

Members
S3Location
  • Required: Yes
  • Type: S3Location structure

A location in Amazon S3.

PackageVersionOutputConfig

Description

A package version output configuration.

Members
MarkLatest
  • Type: boolean

Indicates that the version is recommended for all users.

PackageName
  • Required: Yes
  • Type: string

The output's package name.

PackageVersion
  • Required: Yes
  • Type: string

The output's package version.

ResourceNotFoundException

Description

The target resource was not found.

Members
Message
  • Required: Yes
  • Type: string
ResourceId
  • Required: Yes
  • Type: string

The resource's ID.

ResourceType
  • Required: Yes
  • Type: string

The resource's type.

S3Location

Description

A location in Amazon S3.

Members
BucketName
  • Required: Yes
  • Type: string

A bucket name.

ObjectKey
  • Required: Yes
  • Type: string

An object key.

Region
  • Type: string

The bucket's Region.

ServiceQuotaExceededException

Description

The request would cause a limit to be exceeded.

Members
Message
  • Required: Yes
  • Type: string
QuotaCode
  • Required: Yes
  • Type: string

The name of the limit.

ResourceId
  • Type: string

The target resource's ID.

ResourceType
  • Type: string

The target resource's type.

ServiceCode
  • Required: Yes
  • Type: string

The name of the service.

StaticIpConnectionInfo

Description

A static IP configuration.

Members
DefaultGateway
  • Required: Yes
  • Type: string

The connection's default gateway.

Dns
  • Required: Yes
  • Type: Array of strings

The connection's DNS address.

IpAddress
  • Required: Yes
  • Type: string

The connection's IP address.

Mask
  • Required: Yes
  • Type: string

The connection's DNS mask.

StorageLocation

Description

A storage location.

Members
BinaryPrefixLocation
  • Required: Yes
  • Type: string

The location's binary prefix.

Bucket
  • Required: Yes
  • Type: string

The location's bucket.

GeneratedPrefixLocation
  • Required: Yes
  • Type: string

The location's generated prefix.

ManifestPrefixLocation
  • Required: Yes
  • Type: string

The location's manifest prefix.

RepoPrefixLocation
  • Required: Yes
  • Type: string

The location's repo prefix.

ValidationException

Description

The request contains an invalid parameter value.

Members
ErrorArguments
  • Type: Array of ValidationExceptionErrorArgument structures

A list of attributes that led to the exception and their values.

ErrorId
  • Type: string

A unique ID for the error.

Fields
  • Type: Array of ValidationExceptionField structures

A list of request parameters that failed validation.

Message
  • Required: Yes
  • Type: string
Reason
  • Type: string

The reason that validation failed.

ValidationExceptionErrorArgument

Description

A validation exception error argument.

Members
Name
  • Required: Yes
  • Type: string

The argument's name.

Value
  • Required: Yes
  • Type: string

The argument's value.

ValidationExceptionField

Description

A validation exception field.

Members
Message
  • Required: Yes
  • Type: string

The field's message.

Name
  • Required: Yes
  • Type: string

The field's name.

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