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
    • ARCZonalShift
      • 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
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudTrailData
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • 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
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • 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
    • DocDBElastic
      • 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
    • EndpointV2
      • Rule
      • Ruleset
    • 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
    • InternetMonitor
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • IVSRealTime
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • 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
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • 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
    • Pipes
      • 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
    • ResourceExplorer2
      • 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
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Tnb
      • Exception
    • Token
    • 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\ARCZonalShift\ARCZonalShiftClient
  • 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\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • 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\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • 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\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • 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\DocDBElastic\DocDBElasticClient
  • 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\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • 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\InternetMonitor\InternetMonitorClient
  • 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\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • 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\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • 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\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • 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\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • 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\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • 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\Pipes\PipesClient
  • 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\ResourceExplorer2\ResourceExplorer2Client
  • 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\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • 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\SimSpaceWeaver\SimSpaceWeaverClient
  • 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\SsmSap\SsmSapClient
  • 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\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • 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
  • Aws\Token\RefreshableTokenProviderInterface
  • Aws\Token\TokenAuthorization
  • Aws\Token\TokenInterface

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
  • Aws\Token\ParsesIniTrait

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\ARCZonalShift\Exception\ARCZonalShiftException
  • 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\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • 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\CloudTrailData\Exception\CloudTrailDataException
  • 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\CodeCatalyst\Exception\CodeCatalystException
  • 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\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • 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\DocDBElastic\Exception\DocDBElasticException
  • 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\TokenException
  • 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\InternetMonitor\Exception\InternetMonitorException
  • 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\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • 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\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • 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\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • 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\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • 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\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • 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\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • 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\Pipes\Exception\PipesException
  • 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\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • 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\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • 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\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • 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\SsmSap\Exception\SsmSapException
  • 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\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • 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 Private 5G 2021-12-03

Client: Aws\PrivateNetworks\PrivateNetworksClient
Service ID: privatenetworks
Version: 2021-12-03

This page describes the parameters and results for the operations of the AWS Private 5G (2021-12-03), and shows how to use the Aws\PrivateNetworks\PrivateNetworksClient object to call the described operations. This documentation is specific to the 2021-12-03 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 */).

  • AcknowledgeOrderReceipt ( array $params = [] )

    Acknowledges that the specified network order was received.

  • ActivateDeviceIdentifier ( array $params = [] )

    Activates the specified device identifier.

  • ActivateNetworkSite ( array $params = [] )

    Activates the specified network site.

  • ConfigureAccessPoint ( array $params = [] )

    Configures the specified network resource.

  • CreateNetwork ( array $params = [] )

    Creates a network.

  • CreateNetworkSite ( array $params = [] )

    Creates a network site.

  • DeactivateDeviceIdentifier ( array $params = [] )

    Deactivates the specified device identifier.

  • DeleteNetwork ( array $params = [] )

    Deletes the specified network.

  • DeleteNetworkSite ( array $params = [] )

    Deletes the specified network site.

  • GetDeviceIdentifier ( array $params = [] )

    Gets the specified device identifier.

  • GetNetwork ( array $params = [] )

    Gets the specified network.

  • GetNetworkResource ( array $params = [] )

    Gets the specified network resource.

  • GetNetworkSite ( array $params = [] )

    Gets the specified network site.

  • GetOrder ( array $params = [] )

    Gets the specified order.

  • ListDeviceIdentifiers ( array $params = [] )

    Lists device identifiers.

  • ListNetworkResources ( array $params = [] )

    Lists network resources.

  • ListNetworkSites ( array $params = [] )

    Lists network sites.

  • ListNetworks ( array $params = [] )

    Lists networks.

  • ListOrders ( array $params = [] )

    Lists orders.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for the specified resource.

  • Ping ( array $params = [] )

    Checks the health of the service.

  • StartNetworkResourceUpdate ( array $params = [] )

    Starts an update of the specified network resource.

  • TagResource ( array $params = [] )

    Adds tags to the specified resource.

  • UntagResource ( array $params = [] )

    Removes tags from the specified resource.

  • UpdateNetworkSite ( array $params = [] )

    Updates the specified network site.

  • UpdateNetworkSitePlan ( array $params = [] )

    Updates the specified network site plan.

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:

  • ListDeviceIdentifiers
  • ListNetworkResources
  • ListNetworkSites
  • ListNetworks
  • ListOrders

Operations

AcknowledgeOrderReceipt

$result = $client->acknowledgeOrderReceipt([/* ... */]);
$promise = $client->acknowledgeOrderReceiptAsync([/* ... */]);

Acknowledges that the specified network order was received.

Parameter Syntax

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

Parameter Details

Members
orderArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the order.

Result Syntax

[
    'order' => [
        'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
        'createdAt' => <DateTime>,
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'orderArn' => '<string>',
        'shippingAddress' => [
            'city' => '<string>',
            'company' => '<string>',
            'country' => '<string>',
            'name' => '<string>',
            'phoneNumber' => '<string>',
            'postalCode' => '<string>',
            'stateOrProvince' => '<string>',
            'street1' => '<string>',
            'street2' => '<string>',
            'street3' => '<string>',
        ],
        'trackingInformation' => [
            [
                'trackingNumber' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
order
  • Required: Yes
  • Type: Order structure

Information about the order.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ActivateDeviceIdentifier

$result = $client->activateDeviceIdentifier([/* ... */]);
$promise = $client->activateDeviceIdentifierAsync([/* ... */]);

Activates the specified device identifier.

Parameter Syntax

$result = $client->activateDeviceIdentifier([
    'clientToken' => '<string>',
    'deviceIdentifierArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

deviceIdentifierArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the device identifier.

Result Syntax

[
    'deviceIdentifier' => [
        'createdAt' => <DateTime>,
        'deviceIdentifierArn' => '<string>',
        'iccid' => '<string>',
        'imsi' => '<string>',
        'networkArn' => '<string>',
        'orderArn' => '<string>',
        'status' => 'ACTIVE|INACTIVE',
        'trafficGroupArn' => '<string>',
        'vendor' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
deviceIdentifier
  • Required: Yes
  • Type: DeviceIdentifier structure

Information about the device identifier.

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

The tags on the device identifier.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ActivateNetworkSite

$result = $client->activateNetworkSite([/* ... */]);
$promise = $client->activateNetworkSiteAsync([/* ... */]);

Activates the specified network site.

Parameter Syntax

$result = $client->activateNetworkSite([
    'clientToken' => '<string>',
    'networkSiteArn' => '<string>', // REQUIRED
    'shippingAddress' => [ // REQUIRED
        'city' => '<string>', // REQUIRED
        'company' => '<string>',
        'country' => '<string>', // REQUIRED
        'name' => '<string>', // REQUIRED
        'phoneNumber' => '<string>',
        'postalCode' => '<string>', // REQUIRED
        'stateOrProvince' => '<string>', // REQUIRED
        'street1' => '<string>', // REQUIRED
        'street2' => '<string>',
        'street3' => '<string>',
    ],
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

shippingAddress
  • Required: Yes
  • Type: Address structure

The shipping address of the network site.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ConfigureAccessPoint

$result = $client->configureAccessPoint([/* ... */]);
$promise = $client->configureAccessPointAsync([/* ... */]);

Configures the specified network resource.

Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see Radio units in the Amazon Web Services Private 5G User Guide.

Parameter Syntax

$result = $client->configureAccessPoint([
    'accessPointArn' => '<string>', // REQUIRED
    'cpiSecretKey' => '<string>',
    'cpiUserId' => '<string>',
    'cpiUserPassword' => '<string>',
    'cpiUsername' => '<string>',
    'position' => [
        'elevation' => <float>,
        'elevationReference' => 'AGL|AMSL',
        'elevationUnit' => 'FEET',
        'latitude' => <float>,
        'longitude' => <float>,
    ],
]);

Parameter Details

Members
accessPointArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network resource.

cpiSecretKey
  • Type: string

A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

cpiUserId
  • Type: string

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

cpiUserPassword
  • Type: string

The CPI password associated with the CPI certificate in cpiSecretKey.

cpiUsername
  • Type: string

The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

position
  • Type: Position structure

The position of the network resource.

Result Syntax

[
    'accessPoint' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'health' => 'INITIAL|HEALTHY|UNHEALTHY',
        'model' => '<string>',
        'networkArn' => '<string>',
        'networkResourceArn' => '<string>',
        'networkSiteArn' => '<string>',
        'orderArn' => '<string>',
        'position' => [
            'elevation' => <float>,
            'elevationReference' => 'AGL|AMSL',
            'elevationUnit' => 'FEET',
            'latitude' => <float>,
            'longitude' => <float>,
        ],
        'returnInformation' => [
            'replacementOrderArn' => '<string>',
            'returnReason' => '<string>',
            'shippingAddress' => [
                'city' => '<string>',
                'company' => '<string>',
                'country' => '<string>',
                'name' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'stateOrProvince' => '<string>',
                'street1' => '<string>',
                'street2' => '<string>',
                'street3' => '<string>',
            ],
            'shippingLabel' => '<string>',
        ],
        'serialNumber' => '<string>',
        'status' => 'PENDING|SHIPPED|PROVISIONING|PROVISIONED|AVAILABLE|DELETING|PENDING_RETURN|DELETED|CREATING_SHIPPING_LABEL',
        'statusReason' => '<string>',
        'type' => 'RADIO_UNIT',
        'vendor' => '<string>',
    ],
]

Result Details

Members
accessPoint
  • Required: Yes
  • Type: NetworkResource structure

Information about the network resource.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

CreateNetwork

$result = $client->createNetwork([/* ... */]);
$promise = $client->createNetworkAsync([/* ... */]);

Creates a network.

Parameter Syntax

$result = $client->createNetwork([
    'clientToken' => '<string>',
    'description' => '<string>',
    'networkName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

description
  • Type: string

The description of the network.

networkName
  • Required: Yes
  • Type: string

The name of the network. You can't change the name after you create the network.

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

The tags to apply to the network.

Result Syntax

[
    'network' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkName' => '<string>',
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
network
  • Required: Yes
  • Type: Network structure

Information about the network.

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

The network tags.

Errors

  • LimitExceededException:

    The limit was exceeded.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

CreateNetworkSite

$result = $client->createNetworkSite([/* ... */]);
$promise = $client->createNetworkSiteAsync([/* ... */]);

Creates a network site.

Parameter Syntax

$result = $client->createNetworkSite([
    'availabilityZone' => '<string>',
    'availabilityZoneId' => '<string>',
    'clientToken' => '<string>',
    'description' => '<string>',
    'networkArn' => '<string>', // REQUIRED
    'networkSiteName' => '<string>', // REQUIRED
    'pendingPlan' => [
        'options' => [
            [
                'name' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceDefinitions' => [
            [
                'count' => <integer>, // REQUIRED
                'options' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER', // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
availabilityZone
  • Type: string

The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

availabilityZoneId
  • Type: string

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.

clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

description
  • Type: string

The description of the site.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

networkSiteName
  • Required: Yes
  • Type: string

The name of the site. You can't change the name after you create the site.

pendingPlan
  • Type: SitePlan structure

Information about the pending plan for this site.

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

The tags to apply to the network site.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

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

The network site tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

DeactivateDeviceIdentifier

$result = $client->deactivateDeviceIdentifier([/* ... */]);
$promise = $client->deactivateDeviceIdentifierAsync([/* ... */]);

Deactivates the specified device identifier.

Parameter Syntax

$result = $client->deactivateDeviceIdentifier([
    'clientToken' => '<string>',
    'deviceIdentifierArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

deviceIdentifierArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the device identifier.

Result Syntax

[
    'deviceIdentifier' => [
        'createdAt' => <DateTime>,
        'deviceIdentifierArn' => '<string>',
        'iccid' => '<string>',
        'imsi' => '<string>',
        'networkArn' => '<string>',
        'orderArn' => '<string>',
        'status' => 'ACTIVE|INACTIVE',
        'trafficGroupArn' => '<string>',
        'vendor' => '<string>',
    ],
]

Result Details

Members
deviceIdentifier
  • Required: Yes
  • Type: DeviceIdentifier structure

Information about the device identifier.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

DeleteNetwork

$result = $client->deleteNetwork([/* ... */]);
$promise = $client->deleteNetworkAsync([/* ... */]);

Deletes the specified network. You must delete network sites before you delete the network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private 5G.

Parameter Syntax

$result = $client->deleteNetwork([
    'clientToken' => '<string>',
    'networkArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

Result Syntax

[
    'network' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkName' => '<string>',
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
network
  • Required: Yes
  • Type: Network structure

Information about the network.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

DeleteNetworkSite

$result = $client->deleteNetworkSite([/* ... */]);
$promise = $client->deleteNetworkSiteAsync([/* ... */]);

Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see Hardware returns in the Amazon Web Services Private 5G User Guide.

Parameter Syntax

$result = $client->deleteNetworkSite([
    'clientToken' => '<string>',
    'networkSiteArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

GetDeviceIdentifier

$result = $client->getDeviceIdentifier([/* ... */]);
$promise = $client->getDeviceIdentifierAsync([/* ... */]);

Gets the specified device identifier.

Parameter Syntax

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

Parameter Details

Members
deviceIdentifierArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the device identifier.

Result Syntax

[
    'deviceIdentifier' => [
        'createdAt' => <DateTime>,
        'deviceIdentifierArn' => '<string>',
        'iccid' => '<string>',
        'imsi' => '<string>',
        'networkArn' => '<string>',
        'orderArn' => '<string>',
        'status' => 'ACTIVE|INACTIVE',
        'trafficGroupArn' => '<string>',
        'vendor' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
deviceIdentifier
  • Type: DeviceIdentifier structure

Information about the device identifier.

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

The device identifier tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

GetNetwork

$result = $client->getNetwork([/* ... */]);
$promise = $client->getNetworkAsync([/* ... */]);

Gets the specified network.

Parameter Syntax

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

Parameter Details

Members
networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

Result Syntax

[
    'network' => [
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkName' => '<string>',
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
network
  • Required: Yes
  • Type: Network structure

Information about the network.

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

The network tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

GetNetworkResource

$result = $client->getNetworkResource([/* ... */]);
$promise = $client->getNetworkResourceAsync([/* ... */]);

Gets the specified network resource.

Parameter Syntax

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

Parameter Details

Members
networkResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network resource.

Result Syntax

[
    'networkResource' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'health' => 'INITIAL|HEALTHY|UNHEALTHY',
        'model' => '<string>',
        'networkArn' => '<string>',
        'networkResourceArn' => '<string>',
        'networkSiteArn' => '<string>',
        'orderArn' => '<string>',
        'position' => [
            'elevation' => <float>,
            'elevationReference' => 'AGL|AMSL',
            'elevationUnit' => 'FEET',
            'latitude' => <float>,
            'longitude' => <float>,
        ],
        'returnInformation' => [
            'replacementOrderArn' => '<string>',
            'returnReason' => '<string>',
            'shippingAddress' => [
                'city' => '<string>',
                'company' => '<string>',
                'country' => '<string>',
                'name' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'stateOrProvince' => '<string>',
                'street1' => '<string>',
                'street2' => '<string>',
                'street3' => '<string>',
            ],
            'shippingLabel' => '<string>',
        ],
        'serialNumber' => '<string>',
        'status' => 'PENDING|SHIPPED|PROVISIONING|PROVISIONED|AVAILABLE|DELETING|PENDING_RETURN|DELETED|CREATING_SHIPPING_LABEL',
        'statusReason' => '<string>',
        'type' => 'RADIO_UNIT',
        'vendor' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
networkResource
  • Required: Yes
  • Type: NetworkResource structure

Information about the network resource.

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

The network resource tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

GetNetworkSite

$result = $client->getNetworkSite([/* ... */]);
$promise = $client->getNetworkSiteAsync([/* ... */]);

Gets the specified network site.

Parameter Syntax

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

Parameter Details

Members
networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

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

The network site tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

GetOrder

$result = $client->getOrder([/* ... */]);
$promise = $client->getOrderAsync([/* ... */]);

Gets the specified order.

Parameter Syntax

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

Parameter Details

Members
orderArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the order.

Result Syntax

[
    'order' => [
        'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
        'createdAt' => <DateTime>,
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'orderArn' => '<string>',
        'shippingAddress' => [
            'city' => '<string>',
            'company' => '<string>',
            'country' => '<string>',
            'name' => '<string>',
            'phoneNumber' => '<string>',
            'postalCode' => '<string>',
            'stateOrProvince' => '<string>',
            'street1' => '<string>',
            'street2' => '<string>',
            'street3' => '<string>',
        ],
        'trackingInformation' => [
            [
                'trackingNumber' => '<string>',
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
order
  • Required: Yes
  • Type: Order structure

Information about the order.

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

The order tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListDeviceIdentifiers

$result = $client->listDeviceIdentifiers([/* ... */]);
$promise = $client->listDeviceIdentifiersAsync([/* ... */]);

Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

Parameter Syntax

$result = $client->listDeviceIdentifiers([
    'filters' => [
        '<DeviceIdentifierFilterKeys>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'networkArn' => '<string>', // REQUIRED
    'startToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Associative array of custom strings keys (DeviceIdentifierFilterKeys) to stringss

The filters.

  • ORDER - The Amazon Resource Name (ARN) of the order.

  • STATUS - The status (ACTIVE | INACTIVE).

  • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults
  • Type: int

The maximum number of results to return.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

startToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'deviceIdentifiers' => [
        [
            'createdAt' => <DateTime>,
            'deviceIdentifierArn' => '<string>',
            'iccid' => '<string>',
            'imsi' => '<string>',
            'networkArn' => '<string>',
            'orderArn' => '<string>',
            'status' => 'ACTIVE|INACTIVE',
            'trafficGroupArn' => '<string>',
            'vendor' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
deviceIdentifiers
  • Type: Array of DeviceIdentifier structures

Information about the device identifiers.

nextToken
  • Type: string

The token for the next page of results.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListNetworkResources

$result = $client->listNetworkResources([/* ... */]);
$promise = $client->listNetworkResourcesAsync([/* ... */]);

Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

Parameter Syntax

$result = $client->listNetworkResources([
    'filters' => [
        '<NetworkResourceFilterKeys>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'networkArn' => '<string>', // REQUIRED
    'startToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Associative array of custom strings keys (NetworkResourceFilterKeys) to stringss

The filters.

  • ORDER - The Amazon Resource Name (ARN) of the order.

  • STATUS - The status (AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults
  • Type: int

The maximum number of results to return.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

startToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'networkResources' => [
        [
            'attributes' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'health' => 'INITIAL|HEALTHY|UNHEALTHY',
            'model' => '<string>',
            'networkArn' => '<string>',
            'networkResourceArn' => '<string>',
            'networkSiteArn' => '<string>',
            'orderArn' => '<string>',
            'position' => [
                'elevation' => <float>,
                'elevationReference' => 'AGL|AMSL',
                'elevationUnit' => 'FEET',
                'latitude' => <float>,
                'longitude' => <float>,
            ],
            'returnInformation' => [
                'replacementOrderArn' => '<string>',
                'returnReason' => '<string>',
                'shippingAddress' => [
                    'city' => '<string>',
                    'company' => '<string>',
                    'country' => '<string>',
                    'name' => '<string>',
                    'phoneNumber' => '<string>',
                    'postalCode' => '<string>',
                    'stateOrProvince' => '<string>',
                    'street1' => '<string>',
                    'street2' => '<string>',
                    'street3' => '<string>',
                ],
                'shippingLabel' => '<string>',
            ],
            'serialNumber' => '<string>',
            'status' => 'PENDING|SHIPPED|PROVISIONING|PROVISIONED|AVAILABLE|DELETING|PENDING_RETURN|DELETED|CREATING_SHIPPING_LABEL',
            'statusReason' => '<string>',
            'type' => 'RADIO_UNIT',
            'vendor' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
networkResources
  • Type: Array of NetworkResource structures

Information about network resources.

nextToken
  • Type: string

The token for the next page of results.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListNetworkSites

$result = $client->listNetworkSites([/* ... */]);
$promise = $client->listNetworkSitesAsync([/* ... */]);

Lists network sites. Add filters to your request to return a more specific list of results. Use filters to match the status of the network site.

Parameter Syntax

$result = $client->listNetworkSites([
    'filters' => [
        '<NetworkSiteFilterKeys>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'networkArn' => '<string>', // REQUIRED
    'startToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Associative array of custom strings keys (NetworkSiteFilterKeys) to stringss

The filters. Add filters to your request to return a more specific list of results. Use filters to match the status of the network sites.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults
  • Type: int

The maximum number of results to return.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

startToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'networkSites' => [
        [
            'availabilityZone' => '<string>',
            'availabilityZoneId' => '<string>',
            'createdAt' => <DateTime>,
            'currentPlan' => [
                'options' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'resourceDefinitions' => [
                    [
                        'count' => <integer>,
                        'options' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                    ],
                    // ...
                ],
            ],
            'description' => '<string>',
            'networkArn' => '<string>',
            'networkSiteArn' => '<string>',
            'networkSiteName' => '<string>',
            'pendingPlan' => [
                'options' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'resourceDefinitions' => [
                    [
                        'count' => <integer>,
                        'options' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                    ],
                    // ...
                ],
            ],
            'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
networkSites
  • Type: Array of NetworkSite structures

Information about the network sites.

nextToken
  • Type: string

The token for the next page of results.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListNetworks

$result = $client->listNetworks([/* ... */]);
$promise = $client->listNetworksAsync([/* ... */]);

Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.

Parameter Syntax

$result = $client->listNetworks([
    'filters' => [
        '<NetworkFilterKeys>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'startToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Associative array of custom strings keys (NetworkFilterKeys) to stringss

The filters.

  • STATUS - The status (AVAILABLE | CREATED | DELETED | DEPROVISIONING | PROVISIONING).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults
  • Type: int

The maximum number of results to return.

startToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'networks' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'networkArn' => '<string>',
            'networkName' => '<string>',
            'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
            'statusReason' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
networks
  • Type: Array of Network structures

The networks.

nextToken
  • Type: string

The token for the next page of results.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListOrders

$result = $client->listOrders([/* ... */]);
$promise = $client->listOrdersAsync([/* ... */]);

Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

Parameter Syntax

$result = $client->listOrders([
    'filters' => [
        '<OrderFilterKeys>' => ['<string>', ...],
        // ...
    ],
    'maxResults' => <integer>,
    'networkArn' => '<string>', // REQUIRED
    'startToken' => '<string>',
]);

Parameter Details

Members
filters
  • Type: Associative array of custom strings keys (OrderFilterKeys) to stringss

The filters.

  • NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.

  • STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED | UNACKNOWLEDGED).

Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

maxResults
  • Type: int

The maximum number of results to return.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

startToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'nextToken' => '<string>',
    'orders' => [
        [
            'acknowledgmentStatus' => 'ACKNOWLEDGING|ACKNOWLEDGED|UNACKNOWLEDGED',
            'createdAt' => <DateTime>,
            'networkArn' => '<string>',
            'networkSiteArn' => '<string>',
            'orderArn' => '<string>',
            'shippingAddress' => [
                'city' => '<string>',
                'company' => '<string>',
                'country' => '<string>',
                'name' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'stateOrProvince' => '<string>',
                'street1' => '<string>',
                'street2' => '<string>',
                'street3' => '<string>',
            ],
            'trackingInformation' => [
                [
                    'trackingNumber' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
nextToken
  • Type: string

The token for the next page of results.

orders
  • Type: Array of Order structures

Information about the orders.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

ListTagsForResource

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

Lists the tags for the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

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

Result Details

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

The resource tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

  • ThrottlingException:

    The request was denied due to request throttling.

Ping

$result = $client->ping([/* ... */]);
$promise = $client->pingAsync([/* ... */]);

Checks the health of the service.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members
status
  • Type: string

Information about the health of the service.

Errors

  • InternalServerException:

    Information about an internal error.

StartNetworkResourceUpdate

$result = $client->startNetworkResourceUpdate([/* ... */]);
$promise = $client->startNetworkResourceUpdateAsync([/* ... */]);

Starts an update of the specified network resource.

After you submit a request to replace or return a network resource, the status of the network resource is CREATING_SHIPPING_LABEL. The shipping label is available when the status of the network resource is PENDING_RETURN. After the network resource is successfully returned, its status is DELETED. For more information, see Return a radio unit.

Parameter Syntax

$result = $client->startNetworkResourceUpdate([
    'networkResourceArn' => '<string>', // REQUIRED
    'returnReason' => '<string>',
    'shippingAddress' => [
        'city' => '<string>', // REQUIRED
        'company' => '<string>',
        'country' => '<string>', // REQUIRED
        'name' => '<string>', // REQUIRED
        'phoneNumber' => '<string>',
        'postalCode' => '<string>', // REQUIRED
        'stateOrProvince' => '<string>', // REQUIRED
        'street1' => '<string>', // REQUIRED
        'street2' => '<string>',
        'street3' => '<string>',
    ],
    'updateType' => 'REPLACE|RETURN', // REQUIRED
]);

Parameter Details

Members
networkResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network resource.

returnReason
  • Type: string

The reason for the return. Providing a reason for a return is optional.

shippingAddress
  • Type: Address structure

The shipping address. If you don't provide a shipping address when replacing or returning a network resource, we use the address from the original order for the network resource.

updateType
  • Required: Yes
  • Type: string

The update type.

  • REPLACE - Submits a request to replace a defective radio unit. We provide a shipping label that you can use for the return process and we ship a replacement radio unit to you.

  • RETURN - Submits a request to replace a radio unit that you no longer need. We provide a shipping label that you can use for the return process.

Result Syntax

[
    'networkResource' => [
        'attributes' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'description' => '<string>',
        'health' => 'INITIAL|HEALTHY|UNHEALTHY',
        'model' => '<string>',
        'networkArn' => '<string>',
        'networkResourceArn' => '<string>',
        'networkSiteArn' => '<string>',
        'orderArn' => '<string>',
        'position' => [
            'elevation' => <float>,
            'elevationReference' => 'AGL|AMSL',
            'elevationUnit' => 'FEET',
            'latitude' => <float>,
            'longitude' => <float>,
        ],
        'returnInformation' => [
            'replacementOrderArn' => '<string>',
            'returnReason' => '<string>',
            'shippingAddress' => [
                'city' => '<string>',
                'company' => '<string>',
                'country' => '<string>',
                'name' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'stateOrProvince' => '<string>',
                'street1' => '<string>',
                'street2' => '<string>',
                'street3' => '<string>',
            ],
            'shippingLabel' => '<string>',
        ],
        'serialNumber' => '<string>',
        'status' => 'PENDING|SHIPPED|PROVISIONING|PROVISIONED|AVAILABLE|DELETING|PENDING_RETURN|DELETED|CREATING_SHIPPING_LABEL',
        'statusReason' => '<string>',
        'type' => 'RADIO_UNIT',
        'vendor' => '<string>',
    ],
]

Result Details

Members
networkResource
  • Type: NetworkResource structure

The network resource.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

TagResource

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

Adds tags to the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

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

The tags to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

  • ThrottlingException:

    The request was denied due to request throttling.

UntagResource

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

Removes tags from the specified resource.

Parameter Syntax

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

Parameter Details

Members
resourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
  • Required: Yes
  • Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • AccessDeniedException:

    You do not have permission to perform this operation.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

  • ThrottlingException:

    The request was denied due to request throttling.

UpdateNetworkSite

$result = $client->updateNetworkSite([/* ... */]);
$promise = $client->updateNetworkSiteAsync([/* ... */]);

Updates the specified network site.

Parameter Syntax

$result = $client->updateNetworkSite([
    'clientToken' => '<string>',
    'description' => '<string>',
    'networkSiteArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

description
  • Type: string

The description.

networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

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

The network site tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

UpdateNetworkSitePlan

$result = $client->updateNetworkSitePlan([/* ... */]);
$promise = $client->updateNetworkSitePlanAsync([/* ... */]);

Updates the specified network site plan.

Parameter Syntax

$result = $client->updateNetworkSitePlan([
    'clientToken' => '<string>',
    'networkSiteArn' => '<string>', // REQUIRED
    'pendingPlan' => [ // REQUIRED
        'options' => [
            [
                'name' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'resourceDefinitions' => [
            [
                'count' => <integer>, // REQUIRED
                'options' => [
                    [
                        'name' => '<string>', // REQUIRED
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
clientToken
  • Type: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.

networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

pendingPlan
  • Required: Yes
  • Type: SitePlan structure

The pending plan.

Result Syntax

[
    'networkSite' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'createdAt' => <DateTime>,
        'currentPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'networkArn' => '<string>',
        'networkSiteArn' => '<string>',
        'networkSiteName' => '<string>',
        'pendingPlan' => [
            'options' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'resourceDefinitions' => [
                [
                    'count' => <integer>,
                    'options' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'type' => 'RADIO_UNIT|DEVICE_IDENTIFIER',
                ],
                // ...
            ],
        ],
        'status' => 'CREATED|PROVISIONING|AVAILABLE|DEPROVISIONING|DELETED',
        'statusReason' => '<string>',
    ],
    'tags' => ['<string>', ...],
]

Result Details

Members
networkSite
  • Type: NetworkSite structure

Information about the network site.

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

The network site tags.

Errors

  • ResourceNotFoundException:

    The resource was not found.

  • ValidationException:

    The request failed validation.

  • InternalServerException:

    Information about an internal error.

Shapes

AccessDeniedException

Description

You do not have permission to perform this operation.

Members
message
  • Type: string

Address

Description

Information about an address.

Members
city
  • Required: Yes
  • Type: string

The city for this address.

company
  • Type: string

The company name for this address.

country
  • Required: Yes
  • Type: string

The country for this address.

name
  • Required: Yes
  • Type: string

The recipient's name for this address.

phoneNumber
  • Type: string

The phone number for this address.

postalCode
  • Required: Yes
  • Type: string

The postal code for this address.

stateOrProvince
  • Required: Yes
  • Type: string

The state or province for this address.

street1
  • Required: Yes
  • Type: string

The first line of the street address.

street2
  • Type: string

The second line of the street address.

street3
  • Type: string

The third line of the street address.

DeviceIdentifier

Description

Information about a subscriber of a device that can use a network.

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

The creation time of this device identifier.

deviceIdentifierArn
  • Type: string

The Amazon Resource Name (ARN) of the device identifier.

iccid
  • Type: string

The Integrated Circuit Card Identifier of the device identifier.

imsi
  • Type: string

The International Mobile Subscriber Identity of the device identifier.

networkArn
  • Type: string

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

orderArn
  • Type: string

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

status
  • Type: string

The status of the device identifier.

trafficGroupArn
  • Type: string

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

vendor
  • Type: string

The vendor of the device identifier.

InternalServerException

Description

Information about an internal error.

Members
message
  • Required: Yes
  • Type: string

Description of the error.

retryAfterSeconds
  • Type: int

Advice to clients on when the call can be safely retried.

LimitExceededException

Description

The limit was exceeded.

Members
message
  • Required: Yes
  • Type: string

NameValuePair

Description

Information about a name/value pair.

Members
name
  • Required: Yes
  • Type: string

The name of the pair.

value
  • Type: string

The value of the pair.

Network

Description

Information about a network.

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

The creation time of the network.

description
  • Type: string

The description of the network.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network.

networkName
  • Required: Yes
  • Type: string

The name of the network.

status
  • Required: Yes
  • Type: string

The status of the network.

statusReason
  • Type: string

The status reason of the network.

NetworkResource

Description

Information about a network resource.

Members
attributes
  • Type: Array of NameValuePair structures

The attributes of the network resource.

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

The creation time of the network resource.

description
  • Type: string

The description of the network resource.

health
  • Type: string

The health of the network resource.

model
  • Type: string

The model of the network resource.

networkArn
  • Type: string

The Amazon Resource Name (ARN) of the network on which this network resource appears.

networkResourceArn
  • Type: string

The Amazon Resource Name (ARN) of the network resource.

networkSiteArn
  • Type: string

The Amazon Resource Name (ARN) of the network site on which this network resource appears.

orderArn
  • Type: string

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

position
  • Type: Position structure

The position of the network resource.

returnInformation
  • Type: ReturnInformation structure

Information about a request to return the network resource.

serialNumber
  • Type: string

The serial number of the network resource.

status
  • Type: string

The status of the network resource.

statusReason
  • Type: string

The status reason of the network resource.

type
  • Type: string

The type of the network resource.

vendor
  • Type: string

The vendor of the network resource.

NetworkResourceDefinition

Description

Information about a network resource definition.

Members
count
  • Required: Yes
  • Type: int

The count in the network resource definition.

options
  • Type: Array of NameValuePair structures

The options in the network resource definition.

type
  • Required: Yes
  • Type: string

The type in the network resource definition.

NetworkSite

Description

Information about a network site.

Members
availabilityZone
  • Type: string

The parent Availability Zone for the network site.

availabilityZoneId
  • Type: string

The parent Availability Zone ID for the network site.

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

The creation time of the network site.

currentPlan
  • Type: SitePlan structure

The current plan of the network site.

description
  • Type: string

The description of the network site.

networkArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network to which the network site belongs.

networkSiteArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the network site.

networkSiteName
  • Required: Yes
  • Type: string

The name of the network site.

pendingPlan
  • Type: SitePlan structure

The pending plan of the network site.

status
  • Required: Yes
  • Type: string

The status of the network site.

statusReason
  • Type: string

The status reason of the network site.

Order

Description

Information about an order.

Members
acknowledgmentStatus
  • Type: string

The acknowledgement status of the order.

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

The creation time of the order.

networkArn
  • Type: string

The Amazon Resource Name (ARN) of the network associated with this order.

networkSiteArn
  • Type: string

The Amazon Resource Name (ARN) of the network site associated with this order.

orderArn
  • Type: string

The Amazon Resource Name (ARN) of the order.

shippingAddress
  • Type: Address structure

The shipping address of the order.

trackingInformation
  • Type: Array of TrackingInformation structures

The tracking information of the order.

Position

Description

Information about a position.

Members
elevation
  • Type: double

The elevation of the equipment at this position.

elevationReference
  • Type: string

The reference point from which elevation is reported.

elevationUnit
  • Type: string

The units used to measure the elevation of the position.

latitude
  • Type: double

The latitude of the position.

longitude
  • Type: double

The longitude of the position.

ResourceNotFoundException

Description

The resource was not found.

Members
message
  • Required: Yes
  • Type: string

Description of the error.

resourceId
  • Required: Yes
  • Type: string

Identifier of the affected resource.

resourceType
  • Required: Yes
  • Type: string

Type of the affected resource.

ReturnInformation

Description

Information about a request to return a network resource.

Members
replacementOrderArn
  • Type: string

The Amazon Resource Name (ARN) of the replacement order.

returnReason
  • Type: string

The reason for the return. If the return request did not include a reason for the return, this value is null.

shippingAddress
  • Type: Address structure

The shipping address.

shippingLabel
  • Type: string

The URL of the shipping label. The shipping label is available for download only if the status of the network resource is PENDING_RETURN. For more information, see Return a radio unit.

SitePlan

Description

Information about a site plan.

Members
options
  • Type: Array of NameValuePair structures

The options of the plan.

resourceDefinitions
  • Type: Array of NetworkResourceDefinition structures

The resource definitions of the plan.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
  • Type: string

TrackingInformation

Description

Information about tracking a shipment.

Members
trackingNumber
  • Type: string

The tracking number of the shipment.

ValidationException

Description

The request failed validation.

Members
fieldList
  • Type: Array of ValidationExceptionField structures

The list of fields that caused the error, if applicable.

message
  • Required: Yes
  • Type: string

Description of the error.

reason
  • Required: Yes
  • Type: string

Reason the request failed validation.

ValidationExceptionField

Description

Information about a field that failed validation.

Members
message
  • Required: Yes
  • Type: string

The message about the validation failure.

name
  • Required: Yes
  • Type: string

The field name that failed validation.

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