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

Namespaces

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

Classes

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

Interfaces

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

Traits

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

Exceptions

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

Functions

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

AWS Network Manager 2019-07-05

Client: Aws\NetworkManager\NetworkManagerClient
Service ID: networkmanager
Version: 2019-07-05

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

  • AssociateCustomerGateway ( array $params = [] )

    Associates a customer gateway with a device and optionally, with a link.

  • AssociateLink ( array $params = [] )

    Associates a link to a device.

  • AssociateTransitGatewayConnectPeer ( array $params = [] )

    Associates a transit gateway Connect peer with a device, and optionally, with a link.

  • CreateConnection ( array $params = [] )

    Creates a connection between two devices.

  • CreateDevice ( array $params = [] )

    Creates a new device in a global network.

  • CreateGlobalNetwork ( array $params = [] )

    Creates a new, empty global network.

  • CreateLink ( array $params = [] )

    Creates a new link for a specified site.

  • CreateSite ( array $params = [] )

    Creates a new site in a global network.

  • DeleteConnection ( array $params = [] )

    Deletes the specified connection in your global network.

  • DeleteDevice ( array $params = [] )

    Deletes an existing device.

  • DeleteGlobalNetwork ( array $params = [] )

    Deletes an existing global network.

  • DeleteLink ( array $params = [] )

    Deletes an existing link.

  • DeleteSite ( array $params = [] )

    Deletes an existing site.

  • DeregisterTransitGateway ( array $params = [] )

    Deregisters a transit gateway from your global network.

  • DescribeGlobalNetworks ( array $params = [] )

    Describes one or more global networks.

  • DisassociateCustomerGateway ( array $params = [] )

    Disassociates a customer gateway from a device and a link.

  • DisassociateLink ( array $params = [] )

    Disassociates an existing device from a link.

  • DisassociateTransitGatewayConnectPeer ( array $params = [] )

    Disassociates a transit gateway Connect peer from a device and link.

  • GetConnections ( array $params = [] )

    Gets information about one or more of your connections in a global network.

  • GetCustomerGatewayAssociations ( array $params = [] )

    Gets the association information for customer gateways that are associated with devices and links in your global network.

  • GetDevices ( array $params = [] )

    Gets information about one or more of your devices in a global network.

  • GetLinkAssociations ( array $params = [] )

    Gets the link associations for a device or a link.

  • GetLinks ( array $params = [] )

    Gets information about one or more links in a specified global network.

  • GetSites ( array $params = [] )

    Gets information about one or more of your sites in a global network.

  • GetTransitGatewayConnectPeerAssociations ( array $params = [] )

    Gets information about one or more of your transit gateway Connect peer associations in a global network.

  • GetTransitGatewayRegistrations ( array $params = [] )

    Gets information about the transit gateway registrations in a specified global network.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for a specified resource.

  • RegisterTransitGateway ( array $params = [] )

    Registers a transit gateway in your global network.

  • TagResource ( array $params = [] )

    Tags a specified resource.

  • UntagResource ( array $params = [] )

    Removes tags from a specified resource.

  • UpdateConnection ( array $params = [] )

    Updates the information for an existing connection.

  • UpdateDevice ( array $params = [] )

    Updates the details for an existing device.

  • UpdateGlobalNetwork ( array $params = [] )

    Updates an existing global network.

  • UpdateLink ( array $params = [] )

    Updates the details for an existing link.

  • UpdateSite ( array $params = [] )

    Updates the information for an existing site.

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:

  • DescribeGlobalNetworks
  • GetConnections
  • GetCustomerGatewayAssociations
  • GetDevices
  • GetLinkAssociations
  • GetLinks
  • GetSites
  • GetTransitGatewayConnectPeerAssociations
  • GetTransitGatewayRegistrations

Operations

AssociateCustomerGateway

$result = $client->associateCustomerGateway([/* ... */]);
$promise = $client->associateCustomerGatewayAsync([/* ... */]);

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

Parameter Syntax

$result = $client->associateCustomerGateway([
    'CustomerGatewayArn' => '<string>', // REQUIRED
    'DeviceId' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>',
]);

Parameter Details

Members
CustomerGatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

Result Syntax

[
    'CustomerGatewayAssociation' => [
        'CustomerGatewayArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Members
CustomerGatewayAssociation
  • Type: CustomerGatewayAssociation structure

The customer gateway association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

AssociateLink

$result = $client->associateLink([/* ... */]);
$promise = $client->associateLinkAsync([/* ... */]);

Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Required: Yes
  • Type: string

The ID of the link.

Result Syntax

[
    'LinkAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'LinkId' => '<string>',
    ],
]

Result Details

Members
LinkAssociation
  • Type: LinkAssociation structure

The link association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

AssociateTransitGatewayConnectPeer

$result = $client->associateTransitGatewayConnectPeer([/* ... */]);
$promise = $client->associateTransitGatewayConnectPeerAsync([/* ... */]);

Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate transit gateway Connect peers that have been created on a transit gateway that's registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

Parameter Syntax

$result = $client->associateTransitGatewayConnectPeer([
    'DeviceId' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>',
    'TransitGatewayConnectPeerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

TransitGatewayConnectPeerArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the Connect peer.

Result Syntax

[
    'TransitGatewayConnectPeerAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'TransitGatewayConnectPeerArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayConnectPeerAssociation
  • Type: TransitGatewayConnectPeerAssociation structure

The transit gateway Connect peer association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

CreateConnection

$result = $client->createConnection([/* ... */]);
$promise = $client->createConnectionAsync([/* ... */]);

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

Parameter Syntax

$result = $client->createConnection([
    'ConnectedDeviceId' => '<string>', // REQUIRED
    'ConnectedLinkId' => '<string>',
    'Description' => '<string>',
    'DeviceId' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ConnectedDeviceId
  • Required: Yes
  • Type: string

The ID of the second device in the connection.

ConnectedLinkId
  • Type: string

The ID of the link for the second device.

Description
  • Type: string

A description of the connection.

Length Constraints: Maximum length of 256 characters.

DeviceId
  • Required: Yes
  • Type: string

The ID of the first device in the connection.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link for the first device.

Tags
  • Type: Array of Tag structures

The tags to apply to the resource during creation.

Result Syntax

[
    'Connection' => [
        'ConnectedDeviceId' => '<string>',
        'ConnectedLinkId' => '<string>',
        'ConnectionArn' => '<string>',
        'ConnectionId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Connection
  • Type: Connection structure

Information about the connection.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

CreateDevice

$result = $client->createDevice([/* ... */]);
$promise = $client->createDeviceAsync([/* ... */]);

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

Parameter Syntax

$result = $client->createDevice([
    'AWSLocation' => [
        'SubnetArn' => '<string>',
        'Zone' => '<string>',
    ],
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Location' => [
        'Address' => '<string>',
        'Latitude' => '<string>',
        'Longitude' => '<string>',
    ],
    'Model' => '<string>',
    'SerialNumber' => '<string>',
    'SiteId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => '<string>',
    'Vendor' => '<string>',
]);

Parameter Details

Members
AWSLocation
  • Type: AWSLocation structure

The AWS location of the device.

Description
  • Type: string

A description of the device.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

The location of the device.

Model
  • Type: string

The model of the device.

Length Constraints: Maximum length of 128 characters.

SerialNumber
  • Type: string

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

SiteId
  • Type: string

The ID of the site.

Tags
  • Type: Array of Tag structures

The tags to apply to the resource during creation.

Type
  • Type: string

The type of the device.

Vendor
  • Type: string

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

Result Syntax

[
    'Device' => [
        'AWSLocation' => [
            'SubnetArn' => '<string>',
            'Zone' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'Model' => '<string>',
        'SerialNumber' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
        'Vendor' => '<string>',
    ],
]

Result Details

Members
Device
  • Type: Device structure

Information about the device.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

CreateGlobalNetwork

$result = $client->createGlobalNetwork([/* ... */]);
$promise = $client->createGlobalNetworkAsync([/* ... */]);

Creates a new, empty global network.

Parameter Syntax

$result = $client->createGlobalNetwork([
    'Description' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
  • Type: string

A description of the global network.

Length Constraints: Maximum length of 256 characters.

Tags
  • Type: Array of Tag structures

The tags to apply to the resource during creation.

Result Syntax

[
    'GlobalNetwork' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkArn' => '<string>',
        'GlobalNetworkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
GlobalNetwork
  • Type: GlobalNetwork structure

Information about the global network object.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

CreateLink

$result = $client->createLink([/* ... */]);
$promise = $client->createLinkAsync([/* ... */]);

Creates a new link for a specified site.

Parameter Syntax

$result = $client->createLink([
    'Bandwidth' => [ // REQUIRED
        'DownloadSpeed' => <integer>,
        'UploadSpeed' => <integer>,
    ],
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Provider' => '<string>',
    'SiteId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Type' => '<string>',
]);

Parameter Details

Members
Bandwidth
  • Required: Yes
  • Type: Bandwidth structure

The upload speed and download speed in Mbps.

Description
  • Type: string

A description of the link.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Provider
  • Type: string

The provider of the link.

Constraints: Cannot include the following characters: | \ ^

Length Constraints: Maximum length of 128 characters.

SiteId
  • Required: Yes
  • Type: string

The ID of the site.

Tags
  • Type: Array of Tag structures

The tags to apply to the resource during creation.

Type
  • Type: string

The type of the link.

Constraints: Cannot include the following characters: | \ ^

Length Constraints: Maximum length of 128 characters.

Result Syntax

[
    'Link' => [
        'Bandwidth' => [
            'DownloadSpeed' => <integer>,
            'UploadSpeed' => <integer>,
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkArn' => '<string>',
        'LinkId' => '<string>',
        'Provider' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
    ],
]

Result Details

Members
Link
  • Type: Link structure

Information about the link.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

CreateSite

$result = $client->createSite([/* ... */]);
$promise = $client->createSiteAsync([/* ... */]);

Creates a new site in a global network.

Parameter Syntax

$result = $client->createSite([
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Location' => [
        'Address' => '<string>',
        'Latitude' => '<string>',
        'Longitude' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
Description
  • Type: string

A description of your site.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.

  • Address: The physical address of the site.

  • Latitude: The latitude of the site.

  • Longitude: The longitude of the site.

Tags
  • Type: Array of Tag structures

The tags to apply to the resource during creation.

Result Syntax

[
    'Site' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about the site.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeleteConnection

$result = $client->deleteConnection([/* ... */]);
$promise = $client->deleteConnectionAsync([/* ... */]);

Deletes the specified connection in your global network.

Parameter Syntax

$result = $client->deleteConnection([
    'ConnectionId' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConnectionId
  • Required: Yes
  • Type: string

The ID of the connection.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Result Syntax

[
    'Connection' => [
        'ConnectedDeviceId' => '<string>',
        'ConnectedLinkId' => '<string>',
        'ConnectionArn' => '<string>',
        'ConnectionId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Connection
  • Type: Connection structure

Information about the connection.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeleteDevice

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

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Result Syntax

[
    'Device' => [
        'AWSLocation' => [
            'SubnetArn' => '<string>',
            'Zone' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'Model' => '<string>',
        'SerialNumber' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
        'Vendor' => '<string>',
    ],
]

Result Details

Members
Device
  • Type: Device structure

Information about the device.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeleteGlobalNetwork

$result = $client->deleteGlobalNetwork([/* ... */]);
$promise = $client->deleteGlobalNetworkAsync([/* ... */]);

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.

Parameter Syntax

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

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Result Syntax

[
    'GlobalNetwork' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkArn' => '<string>',
        'GlobalNetworkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
GlobalNetwork
  • Type: GlobalNetwork structure

Information about the global network.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeleteLink

$result = $client->deleteLink([/* ... */]);
$promise = $client->deleteLinkAsync([/* ... */]);

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

Parameter Syntax

$result = $client->deleteLink([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Required: Yes
  • Type: string

The ID of the link.

Result Syntax

[
    'Link' => [
        'Bandwidth' => [
            'DownloadSpeed' => <integer>,
            'UploadSpeed' => <integer>,
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkArn' => '<string>',
        'LinkId' => '<string>',
        'Provider' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
    ],
]

Result Details

Members
Link
  • Type: Link structure

Information about the link.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeleteSite

$result = $client->deleteSite([/* ... */]);
$promise = $client->deleteSiteAsync([/* ... */]);

Deletes an existing site. The site cannot be associated with any device or link.

Parameter Syntax

$result = $client->deleteSite([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

SiteId
  • Required: Yes
  • Type: string

The ID of the site.

Result Syntax

[
    'Site' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about the site.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DeregisterTransitGateway

$result = $client->deregisterTransitGateway([/* ... */]);
$promise = $client->deregisterTransitGatewayAsync([/* ... */]);

Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.

Parameter Syntax

$result = $client->deregisterTransitGateway([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'TransitGatewayArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

TransitGatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the transit gateway.

Result Syntax

[
    'TransitGatewayRegistration' => [
        'GlobalNetworkId' => '<string>',
        'State' => [
            'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
            'Message' => '<string>',
        ],
        'TransitGatewayArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayRegistration
  • Type: TransitGatewayRegistration structure

The transit gateway registration information.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DescribeGlobalNetworks

$result = $client->describeGlobalNetworks([/* ... */]);
$promise = $client->describeGlobalNetworksAsync([/* ... */]);

Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get* action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.

Parameter Syntax

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

Parameter Details

Members
GlobalNetworkIds
  • Type: Array of strings

The IDs of one or more global networks. The maximum is 10.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'GlobalNetworks' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'GlobalNetworkArn' => '<string>',
            'GlobalNetworkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
GlobalNetworks
  • Type: Array of GlobalNetwork structures

Information about the global networks.

NextToken
  • Type: string

The token for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DisassociateCustomerGateway

$result = $client->disassociateCustomerGateway([/* ... */]);
$promise = $client->disassociateCustomerGatewayAsync([/* ... */]);

Disassociates a customer gateway from a device and a link.

Parameter Syntax

$result = $client->disassociateCustomerGateway([
    'CustomerGatewayArn' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members
CustomerGatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Result Syntax

[
    'CustomerGatewayAssociation' => [
        'CustomerGatewayArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
    ],
]

Result Details

Members
CustomerGatewayAssociation
  • Type: CustomerGatewayAssociation structure

Information about the customer gateway association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DisassociateLink

$result = $client->disassociateLink([/* ... */]);
$promise = $client->disassociateLinkAsync([/* ... */]);

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

Parameter Syntax

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

Parameter Details

Members
DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Required: Yes
  • Type: string

The ID of the link.

Result Syntax

[
    'LinkAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'LinkId' => '<string>',
    ],
]

Result Details

Members
LinkAssociation
  • Type: LinkAssociation structure

Information about the link association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

DisassociateTransitGatewayConnectPeer

$result = $client->disassociateTransitGatewayConnectPeer([/* ... */]);
$promise = $client->disassociateTransitGatewayConnectPeerAsync([/* ... */]);

Disassociates a transit gateway Connect peer from a device and link.

Parameter Syntax

$result = $client->disassociateTransitGatewayConnectPeer([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'TransitGatewayConnectPeerArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

TransitGatewayConnectPeerArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

Result Syntax

[
    'TransitGatewayConnectPeerAssociation' => [
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        'TransitGatewayConnectPeerArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayConnectPeerAssociation
  • Type: TransitGatewayConnectPeerAssociation structure

The transit gateway Connect peer association.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetConnections

$result = $client->getConnections([/* ... */]);
$promise = $client->getConnectionsAsync([/* ... */]);

Gets information about one or more of your connections in a global network.

Parameter Syntax

$result = $client->getConnections([
    'ConnectionIds' => ['<string>', ...],
    'DeviceId' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConnectionIds
  • Type: Array of strings

One or more connection IDs.

DeviceId
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'Connections' => [
        [
            'ConnectedDeviceId' => '<string>',
            'ConnectedLinkId' => '<string>',
            'ConnectionArn' => '<string>',
            'ConnectionId' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Connections
  • Type: Array of Connection structures

Information about the connections.

NextToken
  • Type: string

The token to use for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetCustomerGatewayAssociations

$result = $client->getCustomerGatewayAssociations([/* ... */]);
$promise = $client->getCustomerGatewayAssociationsAsync([/* ... */]);

Gets the association information for customer gateways that are associated with devices and links in your global network.

Parameter Syntax

$result = $client->getCustomerGatewayAssociations([
    'CustomerGatewayArns' => ['<string>', ...],
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
CustomerGatewayArns
  • Type: Array of strings

One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'CustomerGatewayAssociations' => [
        [
            'CustomerGatewayArn' => '<string>',
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CustomerGatewayAssociations
  • Type: Array of CustomerGatewayAssociation structures

The customer gateway associations.

NextToken
  • Type: string

The token for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetDevices

$result = $client->getDevices([/* ... */]);
$promise = $client->getDevicesAsync([/* ... */]);

Gets information about one or more of your devices in a global network.

Parameter Syntax

$result = $client->getDevices([
    'DeviceIds' => ['<string>', ...],
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SiteId' => '<string>',
]);

Parameter Details

Members
DeviceIds
  • Type: Array of strings

One or more device IDs. The maximum is 10.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

SiteId
  • Type: string

The ID of the site.

Result Syntax

[
    'Devices' => [
        [
            'AWSLocation' => [
                'SubnetArn' => '<string>',
                'Zone' => '<string>',
            ],
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'DeviceArn' => '<string>',
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'Location' => [
                'Address' => '<string>',
                'Latitude' => '<string>',
                'Longitude' => '<string>',
            ],
            'Model' => '<string>',
            'SerialNumber' => '<string>',
            'SiteId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => '<string>',
            'Vendor' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Devices
  • Type: Array of Device structures

The devices.

NextToken
  • Type: string

The token for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetLinkAssociations

$result = $client->getLinkAssociations([/* ... */]);
$promise = $client->getLinkAssociationsAsync([/* ... */]);

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

Parameter Syntax

$result = $client->getLinkAssociations([
    'DeviceId' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
DeviceId
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'LinkAssociations' => [
        [
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkAssociationState' => 'PENDING|AVAILABLE|DELETING|DELETED',
            'LinkId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
LinkAssociations
  • Type: Array of LinkAssociation structures

The link associations.

NextToken
  • Type: string

The token for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetLinks

$result = $client->getLinks([/* ... */]);
$promise = $client->getLinksAsync([/* ... */]);

Gets information about one or more links in a specified global network.

If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.

Parameter Syntax

$result = $client->getLinks([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkIds' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Provider' => '<string>',
    'SiteId' => '<string>',
    'Type' => '<string>',
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkIds
  • Type: Array of strings

One or more link IDs. The maximum is 10.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Provider
  • Type: string

The link provider.

SiteId
  • Type: string

The ID of the site.

Type
  • Type: string

The link type.

Result Syntax

[
    'Links' => [
        [
            'Bandwidth' => [
                'DownloadSpeed' => <integer>,
                'UploadSpeed' => <integer>,
            ],
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkArn' => '<string>',
            'LinkId' => '<string>',
            'Provider' => '<string>',
            'SiteId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Type' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Links
  • Type: Array of Link structures

The links.

NextToken
  • Type: string

The token for the next page of results.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetSites

$result = $client->getSites([/* ... */]);
$promise = $client->getSitesAsync([/* ... */]);

Gets information about one or more of your sites in a global network.

Parameter Syntax

$result = $client->getSites([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SiteIds' => ['<string>', ...],
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

SiteIds
  • Type: Array of strings

One or more site IDs. The maximum is 10.

Result Syntax

[
    'NextToken' => '<string>',
    'Sites' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'GlobalNetworkId' => '<string>',
            'Location' => [
                'Address' => '<string>',
                'Latitude' => '<string>',
                'Longitude' => '<string>',
            ],
            'SiteArn' => '<string>',
            'SiteId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token for the next page of results.

Sites
  • Type: Array of Site structures

The sites.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetTransitGatewayConnectPeerAssociations

$result = $client->getTransitGatewayConnectPeerAssociations([/* ... */]);
$promise = $client->getTransitGatewayConnectPeerAssociationsAsync([/* ... */]);

Gets information about one or more of your transit gateway Connect peer associations in a global network.

Parameter Syntax

$result = $client->getTransitGatewayConnectPeerAssociations([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TransitGatewayConnectPeerArns' => ['<string>', ...],
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

TransitGatewayConnectPeerArns
  • Type: Array of strings

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

Result Syntax

[
    'NextToken' => '<string>',
    'TransitGatewayConnectPeerAssociations' => [
        [
            'DeviceId' => '<string>',
            'GlobalNetworkId' => '<string>',
            'LinkId' => '<string>',
            'State' => 'PENDING|AVAILABLE|DELETING|DELETED',
            'TransitGatewayConnectPeerArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token to use for the next page of results.

TransitGatewayConnectPeerAssociations
  • Type: Array of TransitGatewayConnectPeerAssociation structures

Information about the transit gateway Connect peer associations.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetTransitGatewayRegistrations

$result = $client->getTransitGatewayRegistrations([/* ... */]);
$promise = $client->getTransitGatewayRegistrationsAsync([/* ... */]);

Gets information about the transit gateway registrations in a specified global network.

Parameter Syntax

$result = $client->getTransitGatewayRegistrations([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TransitGatewayArns' => ['<string>', ...],
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

TransitGatewayArns
  • Type: Array of strings

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

Result Syntax

[
    'NextToken' => '<string>',
    'TransitGatewayRegistrations' => [
        [
            'GlobalNetworkId' => '<string>',
            'State' => [
                'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
                'Message' => '<string>',
            ],
            'TransitGatewayArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token for the next page of results.

TransitGatewayRegistrations
  • Type: Array of TransitGatewayRegistration structures

The transit gateway registrations.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

ListTagsForResource

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

Lists the tags for a 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

[
    'TagList' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
TagList
  • Type: Array of Tag structures

The list of tags.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

RegisterTransitGateway

$result = $client->registerTransitGateway([/* ... */]);
$promise = $client->registerTransitGatewayAsync([/* ... */]);

Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.

Parameter Syntax

$result = $client->registerTransitGateway([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'TransitGatewayArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

TransitGatewayArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.

Result Syntax

[
    'TransitGatewayRegistration' => [
        'GlobalNetworkId' => '<string>',
        'State' => [
            'Code' => 'PENDING|AVAILABLE|DELETING|DELETED|FAILED',
            'Message' => '<string>',
        ],
        'TransitGatewayArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayRegistration
  • Type: TransitGatewayRegistration structure

Information about the transit gateway registration.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

TagResource

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

Tags a specified resource.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The Amazon Resource Name (ARN) of the resource.

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

The tags to apply to the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UntagResource

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

Removes tags from a 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 to remove from the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UpdateConnection

$result = $client->updateConnection([/* ... */]);
$promise = $client->updateConnectionAsync([/* ... */]);

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

Parameter Syntax

$result = $client->updateConnection([
    'ConnectedLinkId' => '<string>',
    'ConnectionId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>',
]);

Parameter Details

Members
ConnectedLinkId
  • Type: string

The ID of the link for the second device in the connection.

ConnectionId
  • Required: Yes
  • Type: string

The ID of the connection.

Description
  • Type: string

A description of the connection.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link for the first device in the connection.

Result Syntax

[
    'Connection' => [
        'ConnectedDeviceId' => '<string>',
        'ConnectedLinkId' => '<string>',
        'ConnectionArn' => '<string>',
        'ConnectionId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Connection
  • Type: Connection structure

Information about the connection.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UpdateDevice

$result = $client->updateDevice([/* ... */]);
$promise = $client->updateDeviceAsync([/* ... */]);

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

Parameter Syntax

$result = $client->updateDevice([
    'AWSLocation' => [
        'SubnetArn' => '<string>',
        'Zone' => '<string>',
    ],
    'Description' => '<string>',
    'DeviceId' => '<string>', // REQUIRED
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Location' => [
        'Address' => '<string>',
        'Latitude' => '<string>',
        'Longitude' => '<string>',
    ],
    'Model' => '<string>',
    'SerialNumber' => '<string>',
    'SiteId' => '<string>',
    'Type' => '<string>',
    'Vendor' => '<string>',
]);

Parameter Details

Members
AWSLocation
  • Type: AWSLocation structure

The AWS location of the device.

Description
  • Type: string

A description of the device.

Length Constraints: Maximum length of 256 characters.

DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

Describes a location.

Model
  • Type: string

The model of the device.

Length Constraints: Maximum length of 128 characters.

SerialNumber
  • Type: string

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

SiteId
  • Type: string

The ID of the site.

Type
  • Type: string

The type of the device.

Vendor
  • Type: string

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

Result Syntax

[
    'Device' => [
        'AWSLocation' => [
            'SubnetArn' => '<string>',
            'Zone' => '<string>',
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DeviceArn' => '<string>',
        'DeviceId' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'Model' => '<string>',
        'SerialNumber' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
        'Vendor' => '<string>',
    ],
]

Result Details

Members
Device
  • Type: Device structure

Information about the device.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UpdateGlobalNetwork

$result = $client->updateGlobalNetwork([/* ... */]);
$promise = $client->updateGlobalNetworkAsync([/* ... */]);

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

Parameter Syntax

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

Parameter Details

Members
Description
  • Type: string

A description of the global network.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of your global network.

Result Syntax

[
    'GlobalNetwork' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkArn' => '<string>',
        'GlobalNetworkId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
GlobalNetwork
  • Type: GlobalNetwork structure

Information about the global network object.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UpdateLink

$result = $client->updateLink([/* ... */]);
$promise = $client->updateLinkAsync([/* ... */]);

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

Parameter Syntax

$result = $client->updateLink([
    'Bandwidth' => [
        'DownloadSpeed' => <integer>,
        'UploadSpeed' => <integer>,
    ],
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LinkId' => '<string>', // REQUIRED
    'Provider' => '<string>',
    'Type' => '<string>',
]);

Parameter Details

Members
Bandwidth
  • Type: Bandwidth structure

The upload and download speed in Mbps.

Description
  • Type: string

A description of the link.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LinkId
  • Required: Yes
  • Type: string

The ID of the link.

Provider
  • Type: string

The provider of the link.

Length Constraints: Maximum length of 128 characters.

Type
  • Type: string

The type of the link.

Length Constraints: Maximum length of 128 characters.

Result Syntax

[
    'Link' => [
        'Bandwidth' => [
            'DownloadSpeed' => <integer>,
            'UploadSpeed' => <integer>,
        ],
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'LinkArn' => '<string>',
        'LinkId' => '<string>',
        'Provider' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'Type' => '<string>',
    ],
]

Result Details

Members
Link
  • Type: Link structure

Information about the link.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • ServiceQuotaExceededException:

    A service limit was exceeded.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

UpdateSite

$result = $client->updateSite([/* ... */]);
$promise = $client->updateSiteAsync([/* ... */]);

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

Parameter Syntax

$result = $client->updateSite([
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Location' => [
        'Address' => '<string>',
        'Latitude' => '<string>',
        'Longitude' => '<string>',
    ],
    'SiteId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Description
  • Type: string

A description of your site.

Length Constraints: Maximum length of 256 characters.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

The site location:

  • Address: The physical address of the site.

  • Latitude: The latitude of the site.

  • Longitude: The longitude of the site.

SiteId
  • Required: Yes
  • Type: string

The ID of your site.

Result Syntax

[
    'Site' => [
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'GlobalNetworkId' => '<string>',
        'Location' => [
            'Address' => '<string>',
            'Latitude' => '<string>',
            'Longitude' => '<string>',
        ],
        'SiteArn' => '<string>',
        'SiteId' => '<string>',
        'State' => 'PENDING|AVAILABLE|DELETING|UPDATING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Site
  • Type: Site structure

Information about the site.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ResourceNotFoundException:

    The specified resource could not be found.

  • ConflictException:

    There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

Shapes

AWSLocation

Description

Specifies a location in AWS.

Members
SubnetArn
  • Type: string

The Amazon Resource Name (ARN) of the subnet the device is located in.

Zone
  • Type: string

The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members
Message
  • Required: Yes
  • Type: string

Bandwidth

Description

Describes bandwidth information.

Members
DownloadSpeed
  • Type: int

Download speed in Mbps.

UploadSpeed
  • Type: int

Upload speed in Mbps.

ConflictException

Description

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

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

The ID of the resource.

ResourceType
  • Required: Yes
  • Type: string

The resource type.

Connection

Description

Describes a connection.

Members
ConnectedDeviceId
  • Type: string

The ID of the second device in the connection.

ConnectedLinkId
  • Type: string

The ID of the link for the second device in the connection.

ConnectionArn
  • Type: string

The Amazon Resource Name (ARN) of the connection.

ConnectionId
  • Type: string

The ID of the connection.

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

The date and time that the connection was created.

Description
  • Type: string

The description of the connection.

DeviceId
  • Type: string

The ID of the first device in the connection.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link for the first device in the connection.

State
  • Type: string

The state of the connection.

Tags
  • Type: Array of Tag structures

The tags for the connection.

CustomerGatewayAssociation

Description

Describes the association between a customer gateway, a device, and a link.

Members
CustomerGatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the customer gateway.

DeviceId
  • Type: string

The ID of the device.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

State
  • Type: string

The association state.

Device

Description

Describes a device.

Members
AWSLocation
  • Type: AWSLocation structure

The AWS location of the device.

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

The date and time that the site was created.

Description
  • Type: string

The description of the device.

DeviceArn
  • Type: string

The Amazon Resource Name (ARN) of the device.

DeviceId
  • Type: string

The ID of the device.

GlobalNetworkId
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

The site location.

Model
  • Type: string

The device model.

SerialNumber
  • Type: string

The device serial number.

SiteId
  • Type: string

The site ID.

State
  • Type: string

The device state.

Tags
  • Type: Array of Tag structures

The tags for the device.

Type
  • Type: string

The device type.

Vendor
  • Type: string

The device vendor.

GlobalNetwork

Description

Describes a global network.

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

The date and time that the global network was created.

Description
  • Type: string

The description of the global network.

GlobalNetworkArn
  • Type: string

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

GlobalNetworkId
  • Type: string

The ID of the global network.

State
  • Type: string

The state of the global network.

Tags
  • Type: Array of Tag structures

The tags for the global network.

InternalServerException

Description

The request has failed due to an internal error.

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

Indicates when to retry the request.

Link

Description

Describes a link.

Members
Bandwidth
  • Type: Bandwidth structure

The bandwidth for the link.

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

The date and time that the link was created.

Description
  • Type: string

The description of the link.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkArn
  • Type: string

The Amazon Resource Name (ARN) of the link.

LinkId
  • Type: string

The ID of the link.

Provider
  • Type: string

The provider of the link.

SiteId
  • Type: string

The ID of the site.

State
  • Type: string

The state of the link.

Tags
  • Type: Array of Tag structures

The tags for the link.

Type
  • Type: string

The type of the link.

LinkAssociation

Description

Describes the association between a device and a link.

Members
DeviceId
  • Type: string

The device ID for the link association.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkAssociationState
  • Type: string

The state of the association.

LinkId
  • Type: string

The ID of the link.

Location

Description

Describes a location.

Members
Address
  • Type: string

The physical address.

Latitude
  • Type: string

The latitude.

Longitude
  • Type: string

The longitude.

ResourceNotFoundException

Description

The specified resource could not be found.

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

The ID of the resource.

ResourceType
  • Required: Yes
  • Type: string

The resource type.

ServiceQuotaExceededException

Description

A service limit was exceeded.

Members
LimitCode
  • Required: Yes
  • Type: string

The limit code.

Message
  • Required: Yes
  • Type: string

The error message.

ResourceId
  • Type: string

The ID of the resource.

ResourceType
  • Type: string

The resource type.

ServiceCode
  • Required: Yes
  • Type: string

The service code.

Site

Description

Describes a site.

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

The date and time that the site was created.

Description
  • Type: string

The description of the site.

GlobalNetworkId
  • Type: string

The ID of the global network.

Location
  • Type: Location structure

The location of the site.

SiteArn
  • Type: string

The Amazon Resource Name (ARN) of the site.

SiteId
  • Type: string

The ID of the site.

State
  • Type: string

The state of the site.

Tags
  • Type: Array of Tag structures

The tags for the site.

Tag

Description

Describes a tag.

Members
Key
  • Type: string

The tag key.

Length Constraints: Maximum length of 128 characters.

Value
  • Type: string

The tag value.

Length Constraints: Maximum length of 256 characters.

ThrottlingException

Description

The request was denied due to request throttling.

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

Indicates when to retry the request.

TransitGatewayConnectPeerAssociation

Description

Describes a transit gateway Connect peer association.

Members
DeviceId
  • Type: string

The ID of the device.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

State
  • Type: string

The state of the association.

TransitGatewayConnectPeerArn
  • Type: string

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

TransitGatewayRegistration

Description

Describes the registration of a transit gateway to a global network.

Members
GlobalNetworkId
  • Type: string

The ID of the global network.

State
  • Type: TransitGatewayRegistrationStateReason structure

The state of the transit gateway registration.

TransitGatewayArn
  • Type: string

The Amazon Resource Name (ARN) of the transit gateway.

TransitGatewayRegistrationStateReason

Description

Describes the status of a transit gateway registration.

Members
Code
  • Type: string

The code for the state reason.

Message
  • Type: string

The message for the state reason.

ValidationException

Description

The input fails to satisfy the constraints.

Members
Fields
  • Type: Array of ValidationExceptionField structures

The fields that caused the error, if applicable.

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

The reason for the error.

ValidationExceptionField

Description

Describes a validation exception for a field.

Members
Message
  • Required: Yes
  • Type: string

The message for the field.

Name
  • Required: Yes
  • Type: string

The name of the field.

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