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

Namespaces

  • Aws
    • AccessAnalyzer
      • Exception
    • Account
      • Exception
    • Acm
      • Exception
    • ACMPCA
      • Exception
    • AlexaForBusiness
      • Exception
    • Amplify
      • Exception
    • AmplifyBackend
      • Exception
    • AmplifyUIBuilder
      • Exception
    • Api
      • ErrorParser
      • Parser
        • Exception
      • Serializer
    • ApiGateway
      • Exception
    • ApiGatewayManagementApi
      • Exception
    • ApiGatewayV2
      • Exception
    • AppConfig
      • Exception
    • AppConfigData
      • Exception
    • Appflow
      • Exception
    • AppIntegrationsService
      • Exception
    • ApplicationAutoScaling
      • Exception
    • ApplicationCostProfiler
      • Exception
    • ApplicationDiscoveryService
      • Exception
    • ApplicationInsights
      • Exception
    • AppMesh
      • Exception
    • AppRegistry
      • Exception
    • AppRunner
      • Exception
    • Appstream
      • Exception
    • AppSync
      • Exception
    • ARCZonalShift
      • Exception
    • Arn
      • Exception
    • Athena
      • Exception
    • AuditManager
      • Exception
    • AugmentedAIRuntime
      • Exception
    • AutoScaling
      • Exception
    • AutoScalingPlans
      • Exception
    • Backup
      • Exception
    • BackupGateway
      • Exception
    • BackupStorage
      • Exception
    • Batch
      • Exception
    • BillingConductor
      • Exception
    • Braket
      • Exception
    • Budgets
      • Exception
    • Chime
      • Exception
    • ChimeSDKIdentity
      • Exception
    • ChimeSDKMediaPipelines
      • Exception
    • ChimeSDKMeetings
      • Exception
    • ChimeSDKMessaging
      • Exception
    • ChimeSDKVoice
      • Exception
    • CleanRooms
      • Exception
    • ClientSideMonitoring
      • Exception
    • Cloud9
      • Exception
    • CloudControlApi
      • Exception
    • CloudDirectory
      • Exception
    • CloudFormation
      • Exception
    • CloudFront
      • Exception
    • CloudHsm
      • Exception
    • CloudHSMV2
      • Exception
    • CloudSearch
      • Exception
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudTrailData
      • Exception
    • CloudWatch
      • Exception
    • CloudWatchEvents
      • Exception
    • CloudWatchEvidently
      • Exception
    • CloudWatchLogs
      • Exception
    • CloudWatchRUM
      • Exception
    • CodeArtifact
      • Exception
    • CodeBuild
      • Exception
    • CodeCatalyst
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodeGuruProfiler
      • Exception
    • CodeGuruReviewer
      • Exception
    • CodePipeline
      • Exception
    • CodeStar
      • Exception
    • CodeStarconnections
      • Exception
    • CodeStarNotifications
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoIdentityProvider
      • Exception
    • CognitoSync
      • Exception
    • Comprehend
      • Exception
    • ComprehendMedical
      • Exception
    • ComputeOptimizer
      • Exception
    • ConfigService
      • Exception
    • Connect
      • Exception
    • ConnectCampaignService
      • Exception
    • ConnectCases
      • Exception
    • ConnectContactLens
      • Exception
    • ConnectParticipant
      • Exception
    • ConnectWisdomService
      • Exception
    • ControlTower
      • Exception
    • CostandUsageReportService
      • Exception
    • CostExplorer
      • Exception
    • Credentials
    • Crypto
      • Cipher
      • Polyfill
    • CustomerProfiles
      • Exception
    • DatabaseMigrationService
      • Exception
    • DataExchange
      • Exception
    • DataPipeline
      • Exception
    • DataSync
      • Exception
    • DAX
      • Exception
    • DefaultsMode
      • Exception
    • Detective
      • Exception
    • DeviceFarm
      • Exception
    • DevOpsGuru
      • Exception
    • DirectConnect
      • Exception
    • DirectoryService
      • Exception
    • DLM
      • Exception
    • DocDB
      • Exception
    • DocDBElastic
      • Exception
    • drs
      • Exception
    • DynamoDb
      • Exception
    • DynamoDbStreams
      • Exception
    • EBS
      • Exception
    • Ec2
      • Exception
    • EC2InstanceConnect
      • Exception
    • Ecr
      • Exception
    • ECRPublic
      • Exception
    • Ecs
      • Exception
    • Efs
      • Exception
    • EKS
      • Exception
    • ElastiCache
      • Exception
    • ElasticBeanstalk
      • Exception
    • ElasticInference
      • Exception
    • ElasticLoadBalancing
      • Exception
    • ElasticLoadBalancingV2
      • Exception
    • ElasticsearchService
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Exception
    • EMRContainers
      • Exception
    • EMRServerless
      • Exception
    • Endpoint
      • UseDualstackEndpoint
        • Exception
      • UseFipsEndpoint
        • Exception
    • EndpointDiscovery
      • Exception
    • EndpointV2
      • Rule
      • Ruleset
    • EventBridge
      • Exception
    • Exception
    • finspace
      • Exception
    • FinSpaceData
      • Exception
    • Firehose
      • Exception
    • FIS
      • Exception
    • FMS
      • Exception
    • ForecastQueryService
      • Exception
    • ForecastService
      • Exception
    • FraudDetector
      • Exception
    • FSx
      • Exception
    • GameLift
      • Exception
    • GameSparks
      • Exception
    • Glacier
      • Exception
    • GlobalAccelerator
      • Exception
    • Glue
      • Exception
    • GlueDataBrew
      • Exception
    • Greengrass
      • Exception
    • GreengrassV2
      • Exception
    • GroundStation
      • Exception
    • GuardDuty
      • Exception
    • Handler
      • GuzzleV5
      • GuzzleV6
    • Health
      • Exception
    • HealthLake
      • Exception
    • Honeycode
      • Exception
    • Iam
      • Exception
    • IdentityStore
      • Exception
    • imagebuilder
      • Exception
    • ImportExport
      • Exception
    • Inspector
      • Exception
    • Inspector2
      • Exception
    • InternetMonitor
      • Exception
    • Iot
      • Exception
    • IoT1ClickDevicesService
      • Exception
    • IoT1ClickProjects
      • Exception
    • IoTAnalytics
      • Exception
    • IotDataPlane
      • Exception
    • IoTDeviceAdvisor
      • Exception
    • IoTEvents
      • Exception
    • IoTEventsData
      • Exception
    • IoTFleetHub
      • Exception
    • IoTFleetWise
      • Exception
    • IoTJobsDataPlane
      • Exception
    • IoTRoboRunner
      • Exception
    • IoTSecureTunneling
      • Exception
    • IoTSiteWise
      • Exception
    • IoTThingsGraph
      • Exception
    • IoTTwinMaker
      • Exception
    • IoTWireless
      • Exception
    • IVS
      • Exception
    • ivschat
      • Exception
    • IVSRealTime
      • Exception
    • Kafka
      • Exception
    • KafkaConnect
      • Exception
    • kendra
      • Exception
    • KendraRanking
      • Exception
    • Keyspaces
      • Exception
    • Kinesis
      • Exception
    • KinesisAnalytics
      • Exception
    • KinesisAnalyticsV2
      • Exception
    • KinesisVideo
      • Exception
    • KinesisVideoArchivedMedia
      • Exception
    • KinesisVideoMedia
      • Exception
    • KinesisVideoSignalingChannels
      • Exception
    • KinesisVideoWebRTCStorage
      • Exception
    • Kms
      • Exception
    • LakeFormation
      • Exception
    • Lambda
      • Exception
    • LexModelBuildingService
      • Exception
    • LexModelsV2
      • Exception
    • LexRuntimeService
      • Exception
    • LexRuntimeV2
      • Exception
    • LicenseManager
      • Exception
    • LicenseManagerLinuxSubscriptions
      • Exception
    • LicenseManagerUserSubscriptions
      • Exception
    • Lightsail
      • Exception
    • LocationService
      • Exception
    • LookoutEquipment
      • Exception
    • LookoutforVision
      • Exception
    • LookoutMetrics
      • Exception
    • MachineLearning
      • Exception
    • Macie
      • Exception
    • Macie2
      • Exception
    • MainframeModernization
      • Exception
    • ManagedBlockchain
      • Exception
    • ManagedGrafana
      • Exception
    • MarketplaceCatalog
      • Exception
    • MarketplaceCommerceAnalytics
      • Exception
    • MarketplaceEntitlementService
      • Exception
    • MarketplaceMetering
      • Exception
    • MediaConnect
      • Exception
    • MediaConvert
      • Exception
    • MediaLive
      • Exception
    • MediaPackage
      • Exception
    • MediaPackageVod
      • Exception
    • MediaStore
      • Exception
    • MediaStoreData
      • Exception
    • MediaTailor
      • Exception
    • MemoryDB
      • Exception
    • mgn
      • Exception
    • MigrationHub
      • Exception
    • MigrationHubConfig
      • Exception
    • MigrationHubOrchestrator
      • Exception
    • MigrationHubRefactorSpaces
      • Exception
    • MigrationHubStrategyRecommendations
      • Exception
    • Mobile
      • Exception
    • MQ
      • Exception
    • MTurk
      • Exception
    • Multipart
    • MWAA
      • Exception
    • Neptune
      • Exception
    • NetworkFirewall
      • Exception
    • NetworkManager
      • Exception
    • NimbleStudio
      • Exception
    • OAM
      • Exception
    • Omics
      • Exception
    • OpenSearchServerless
      • Exception
    • OpenSearchService
      • Exception
    • OpsWorks
      • Exception
    • OpsWorksCM
      • Exception
    • Organizations
      • Exception
    • Outposts
      • Exception
    • Panorama
      • Exception
    • Personalize
      • Exception
    • PersonalizeEvents
      • Exception
    • PersonalizeRuntime
      • Exception
    • PI
      • Exception
    • Pinpoint
      • Exception
    • PinpointEmail
      • Exception
    • PinpointSMSVoice
      • Exception
    • PinpointSMSVoiceV2
      • Exception
    • Pipes
      • Exception
    • Polly
      • Exception
    • Pricing
      • Exception
    • PrivateNetworks
      • Exception
    • PrometheusService
      • Exception
    • Proton
      • Exception
    • QLDB
      • Exception
    • QLDBSession
      • Exception
    • QuickSight
      • Exception
    • RAM
      • Exception
    • Rds
      • Exception
    • RDSDataService
      • Exception
    • RecycleBin
      • Exception
    • Redshift
      • Exception
    • RedshiftDataAPIService
      • Exception
    • RedshiftServerless
      • Exception
    • Rekognition
      • Exception
    • ResilienceHub
      • Exception
    • ResourceExplorer2
      • Exception
    • ResourceGroups
      • Exception
    • ResourceGroupsTaggingAPI
      • Exception
    • Retry
      • Exception
    • RoboMaker
      • Exception
    • RolesAnywhere
      • Exception
    • Route53
      • Exception
    • Route53Domains
      • Exception
    • Route53RecoveryCluster
      • Exception
    • Route53RecoveryControlConfig
      • Exception
    • Route53RecoveryReadiness
      • Exception
    • Route53Resolver
      • Exception
    • S3
      • Crypto
      • Exception
      • RegionalEndpoint
        • Exception
      • UseArnRegion
        • Exception
    • S3Control
      • Exception
    • S3Outposts
      • Exception
    • SageMaker
      • Exception
    • SagemakerEdgeManager
      • Exception
    • SageMakerFeatureStoreRuntime
      • Exception
    • SageMakerGeospatial
      • Exception
    • SageMakerMetrics
      • Exception
    • SageMakerRuntime
      • Exception
    • SavingsPlans
      • Exception
    • Scheduler
      • Exception
    • Schemas
      • Exception
    • Script
      • Composer
    • SecretsManager
      • Exception
    • SecurityHub
      • Exception
    • SecurityLake
      • Exception
    • ServerlessApplicationRepository
      • Exception
    • ServiceCatalog
      • Exception
    • ServiceDiscovery
      • Exception
    • ServiceQuotas
      • Exception
    • Ses
      • Exception
    • SesV2
      • Exception
    • Sfn
      • Exception
    • Shield
      • Exception
    • Signature
    • signer
      • Exception
    • SimSpaceWeaver
      • Exception
    • Sms
      • Exception
    • SnowBall
      • Exception
    • SnowDeviceManagement
      • Exception
    • Sns
      • Exception
    • Sqs
      • Exception
    • Ssm
      • Exception
    • SSMContacts
      • Exception
    • SSMIncidents
      • Exception
    • SsmSap
      • Exception
    • SSO
      • Exception
    • SSOAdmin
      • Exception
    • SSOOIDC
      • Exception
    • StorageGateway
      • Exception
    • Sts
      • Exception
      • RegionalEndpoints
        • Exception
    • Support
      • Exception
    • SupportApp
      • Exception
    • Swf
      • Exception
    • Synthetics
      • Exception
    • Textract
      • Exception
    • TimestreamQuery
      • Exception
    • TimestreamWrite
      • Exception
    • Tnb
      • Exception
    • Token
    • TranscribeService
      • Exception
    • Transfer
      • Exception
    • Translate
      • Exception
    • VoiceID
      • Exception
    • Waf
      • Exception
    • WafRegional
      • Exception
    • WAFV2
      • Exception
    • WellArchitected
      • Exception
    • WorkDocs
      • Exception
    • WorkLink
      • Exception
    • WorkMail
      • Exception
    • WorkMailMessageFlow
      • Exception
    • WorkSpaces
      • Exception
    • WorkSpacesWeb
      • Exception
    • XRay
      • Exception
  • GuzzleHttp
    • Promise
    • Psr7
  • Psr
    • Http
      • Message

Classes

  • Aws\AbstractConfigurationProvider
  • Aws\AccessAnalyzer\AccessAnalyzerClient
  • Aws\Account\AccountClient
  • Aws\Acm\AcmClient
  • Aws\ACMPCA\ACMPCAClient
  • Aws\AlexaForBusiness\AlexaForBusinessClient
  • Aws\Amplify\AmplifyClient
  • Aws\AmplifyBackend\AmplifyBackendClient
  • Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
  • Aws\Api\AbstractModel
  • Aws\Api\ApiProvider
  • Aws\Api\DateTimeResult
  • Aws\Api\DocModel
  • Aws\Api\ErrorParser\AbstractErrorParser
  • Aws\Api\ErrorParser\JsonRpcErrorParser
  • Aws\Api\ErrorParser\RestJsonErrorParser
  • Aws\Api\ErrorParser\XmlErrorParser
  • Aws\Api\ListShape
  • Aws\Api\MapShape
  • Aws\Api\Operation
  • Aws\Api\Parser\Crc32ValidatingParser
  • Aws\Api\Parser\DecodingEventStreamIterator
  • Aws\Api\Parser\EventParsingIterator
  • Aws\Api\Parser\JsonParser
  • Aws\Api\Parser\JsonRpcParser
  • Aws\Api\Parser\QueryParser
  • Aws\Api\Parser\RestJsonParser
  • Aws\Api\Parser\RestXmlParser
  • Aws\Api\Parser\XmlParser
  • Aws\Api\Serializer\XmlBody
  • Aws\Api\Service
  • Aws\Api\Shape
  • Aws\Api\ShapeMap
  • Aws\Api\StructureShape
  • Aws\Api\TimestampShape
  • Aws\Api\Validator
  • Aws\ApiGateway\ApiGatewayClient
  • Aws\ApiGatewayManagementApi\ApiGatewayManagementApiClient
  • Aws\ApiGatewayV2\ApiGatewayV2Client
  • Aws\AppConfig\AppConfigClient
  • Aws\AppConfigData\AppConfigDataClient
  • Aws\Appflow\AppflowClient
  • Aws\AppIntegrationsService\AppIntegrationsServiceClient
  • Aws\ApplicationAutoScaling\ApplicationAutoScalingClient
  • Aws\ApplicationCostProfiler\ApplicationCostProfilerClient
  • Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient
  • Aws\ApplicationInsights\ApplicationInsightsClient
  • Aws\AppMesh\AppMeshClient
  • Aws\AppRegistry\AppRegistryClient
  • Aws\AppRunner\AppRunnerClient
  • Aws\Appstream\AppstreamClient
  • Aws\AppSync\AppSyncClient
  • Aws\ARCZonalShift\ARCZonalShiftClient
  • Aws\Athena\AthenaClient
  • Aws\AuditManager\AuditManagerClient
  • Aws\AugmentedAIRuntime\AugmentedAIRuntimeClient
  • Aws\AutoScaling\AutoScalingClient
  • Aws\AutoScalingPlans\AutoScalingPlansClient
  • Aws\AwsClient
  • Aws\Backup\BackupClient
  • Aws\BackupGateway\BackupGatewayClient
  • Aws\BackupStorage\BackupStorageClient
  • Aws\Batch\BatchClient
  • Aws\BillingConductor\BillingConductorClient
  • Aws\Braket\BraketClient
  • Aws\Budgets\BudgetsClient
  • Aws\Chime\ChimeClient
  • Aws\ChimeSDKIdentity\ChimeSDKIdentityClient
  • Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
  • Aws\ChimeSDKMeetings\ChimeSDKMeetingsClient
  • Aws\ChimeSDKMessaging\ChimeSDKMessagingClient
  • Aws\ChimeSDKVoice\ChimeSDKVoiceClient
  • Aws\CleanRooms\CleanRoomsClient
  • Aws\ClientResolver
  • Aws\ClientSideMonitoring\Configuration
  • Aws\ClientSideMonitoring\ConfigurationProvider
  • Aws\Cloud9\Cloud9Client
  • Aws\CloudControlApi\CloudControlApiClient
  • Aws\CloudDirectory\CloudDirectoryClient
  • Aws\CloudFormation\CloudFormationClient
  • Aws\CloudFront\CloudFrontClient
  • Aws\CloudFront\CookieSigner
  • Aws\CloudFront\UrlSigner
  • Aws\CloudHsm\CloudHsmClient
  • Aws\CloudHSMV2\CloudHSMV2Client
  • Aws\CloudSearch\CloudSearchClient
  • Aws\CloudSearchDomain\CloudSearchDomainClient
  • Aws\CloudTrail\CloudTrailClient
  • Aws\CloudTrail\LogFileIterator
  • Aws\CloudTrail\LogFileReader
  • Aws\CloudTrail\LogRecordIterator
  • Aws\CloudTrailData\CloudTrailDataClient
  • Aws\CloudWatch\CloudWatchClient
  • Aws\CloudWatchEvents\CloudWatchEventsClient
  • Aws\CloudWatchEvidently\CloudWatchEvidentlyClient
  • Aws\CloudWatchLogs\CloudWatchLogsClient
  • Aws\CloudWatchRUM\CloudWatchRUMClient
  • Aws\CodeArtifact\CodeArtifactClient
  • Aws\CodeBuild\CodeBuildClient
  • Aws\CodeCatalyst\CodeCatalystClient
  • Aws\CodeCommit\CodeCommitClient
  • Aws\CodeDeploy\CodeDeployClient
  • Aws\CodeGuruProfiler\CodeGuruProfilerClient
  • Aws\CodeGuruReviewer\CodeGuruReviewerClient
  • Aws\CodePipeline\CodePipelineClient
  • Aws\CodeStar\CodeStarClient
  • Aws\CodeStarconnections\CodeStarconnectionsClient
  • Aws\CodeStarNotifications\CodeStarNotificationsClient
  • Aws\CognitoIdentity\CognitoIdentityClient
  • Aws\CognitoIdentity\CognitoIdentityProvider
  • Aws\CognitoIdentityProvider\CognitoIdentityProviderClient
  • Aws\CognitoSync\CognitoSyncClient
  • Aws\Command
  • Aws\CommandPool
  • Aws\Comprehend\ComprehendClient
  • Aws\ComprehendMedical\ComprehendMedicalClient
  • Aws\ComputeOptimizer\ComputeOptimizerClient
  • Aws\ConfigService\ConfigServiceClient
  • Aws\Connect\ConnectClient
  • Aws\ConnectCampaignService\ConnectCampaignServiceClient
  • Aws\ConnectCases\ConnectCasesClient
  • Aws\ConnectContactLens\ConnectContactLensClient
  • Aws\ConnectParticipant\ConnectParticipantClient
  • Aws\ConnectWisdomService\ConnectWisdomServiceClient
  • Aws\ControlTower\ControlTowerClient
  • Aws\CostandUsageReportService\CostandUsageReportServiceClient
  • Aws\CostExplorer\CostExplorerClient
  • Aws\Credentials\AssumeRoleCredentialProvider
  • Aws\Credentials\AssumeRoleWithWebIdentityCredentialProvider
  • Aws\Credentials\CredentialProvider
  • Aws\Credentials\Credentials
  • Aws\Credentials\EcsCredentialProvider
  • Aws\Credentials\InstanceProfileProvider
  • Aws\Crypto\AesDecryptingStream
  • Aws\Crypto\AesEncryptingStream
  • Aws\Crypto\AesGcmDecryptingStream
  • Aws\Crypto\AesGcmEncryptingStream
  • Aws\Crypto\Cipher\Cbc
  • Aws\Crypto\KmsMaterialsProvider
  • Aws\Crypto\KmsMaterialsProviderV2
  • Aws\Crypto\MaterialsProvider
  • Aws\Crypto\MaterialsProviderV2
  • Aws\Crypto\Polyfill\AesGcm
  • Aws\Crypto\Polyfill\ByteArray
  • Aws\Crypto\Polyfill\Gmac
  • Aws\Crypto\Polyfill\Key
  • Aws\CustomerProfiles\CustomerProfilesClient
  • Aws\DatabaseMigrationService\DatabaseMigrationServiceClient
  • Aws\DataExchange\DataExchangeClient
  • Aws\DataPipeline\DataPipelineClient
  • Aws\DataSync\DataSyncClient
  • Aws\DAX\DAXClient
  • Aws\DefaultsMode\Configuration
  • Aws\DefaultsMode\ConfigurationProvider
  • Aws\Detective\DetectiveClient
  • Aws\DeviceFarm\DeviceFarmClient
  • Aws\DevOpsGuru\DevOpsGuruClient
  • Aws\DirectConnect\DirectConnectClient
  • Aws\DirectoryService\DirectoryServiceClient
  • Aws\DLM\DLMClient
  • Aws\DocDB\DocDBClient
  • Aws\DocDBElastic\DocDBElasticClient
  • Aws\DoctrineCacheAdapter
  • Aws\drs\drsClient
  • Aws\DynamoDb\BinaryValue
  • Aws\DynamoDb\DynamoDbClient
  • Aws\DynamoDb\LockingSessionConnection
  • Aws\DynamoDb\Marshaler
  • Aws\DynamoDb\NumberValue
  • Aws\DynamoDb\SessionHandler
  • Aws\DynamoDb\SetValue
  • Aws\DynamoDb\StandardSessionConnection
  • Aws\DynamoDb\WriteRequestBatch
  • Aws\DynamoDbStreams\DynamoDbStreamsClient
  • Aws\EBS\EBSClient
  • Aws\Ec2\Ec2Client
  • Aws\EC2InstanceConnect\EC2InstanceConnectClient
  • Aws\Ecr\EcrClient
  • Aws\ECRPublic\ECRPublicClient
  • Aws\Ecs\EcsClient
  • Aws\Efs\EfsClient
  • Aws\EKS\EKSClient
  • Aws\ElastiCache\ElastiCacheClient
  • Aws\ElasticBeanstalk\ElasticBeanstalkClient
  • Aws\ElasticInference\ElasticInferenceClient
  • Aws\ElasticLoadBalancing\ElasticLoadBalancingClient
  • Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client
  • Aws\ElasticsearchService\ElasticsearchServiceClient
  • Aws\ElasticTranscoder\ElasticTranscoderClient
  • Aws\Emr\EmrClient
  • Aws\EMRContainers\EMRContainersClient
  • Aws\EMRServerless\EMRServerlessClient
  • Aws\Endpoint\EndpointProvider
  • Aws\Endpoint\Partition
  • Aws\Endpoint\PartitionEndpointProvider
  • Aws\Endpoint\PatternEndpointProvider
  • Aws\Endpoint\UseDualstackEndpoint\Configuration
  • Aws\Endpoint\UseDualstackEndpoint\ConfigurationProvider
  • Aws\Endpoint\UseFipsEndpoint\Configuration
  • Aws\Endpoint\UseFipsEndpoint\ConfigurationProvider
  • Aws\EndpointDiscovery\Configuration
  • Aws\EndpointDiscovery\ConfigurationProvider
  • Aws\EndpointDiscovery\EndpointDiscoveryMiddleware
  • Aws\EndpointDiscovery\EndpointList
  • Aws\EndpointV2\EndpointDefinitionProvider
  • Aws\EndpointV2\EndpointProviderV2
  • Aws\EndpointV2\Rule\AbstractRule
  • Aws\EndpointV2\Rule\EndpointRule
  • Aws\EndpointV2\Rule\ErrorRule
  • Aws\EndpointV2\Rule\RuleCreator
  • Aws\EndpointV2\Rule\TreeRule
  • Aws\EndpointV2\Ruleset\Ruleset
  • Aws\EndpointV2\Ruleset\RulesetEndpoint
  • Aws\EndpointV2\Ruleset\RulesetParameter
  • Aws\EventBridge\EventBridgeClient
  • Aws\finspace\finspaceClient
  • Aws\FinSpaceData\FinSpaceDataClient
  • Aws\Firehose\FirehoseClient
  • Aws\FIS\FISClient
  • Aws\FMS\FMSClient
  • Aws\ForecastQueryService\ForecastQueryServiceClient
  • Aws\ForecastService\ForecastServiceClient
  • Aws\FraudDetector\FraudDetectorClient
  • Aws\FSx\FSxClient
  • Aws\GameLift\GameLiftClient
  • Aws\GameSparks\GameSparksClient
  • Aws\Glacier\GlacierClient
  • Aws\Glacier\MultipartUploader
  • Aws\Glacier\TreeHash
  • Aws\GlobalAccelerator\GlobalAcceleratorClient
  • Aws\Glue\GlueClient
  • Aws\GlueDataBrew\GlueDataBrewClient
  • Aws\Greengrass\GreengrassClient
  • Aws\GreengrassV2\GreengrassV2Client
  • Aws\GroundStation\GroundStationClient
  • Aws\GuardDuty\GuardDutyClient
  • Aws\Handler\GuzzleV5\GuzzleHandler
  • Aws\Handler\GuzzleV5\GuzzleStream
  • Aws\Handler\GuzzleV5\PsrStream
  • Aws\Handler\GuzzleV6\GuzzleHandler
  • Aws\HandlerList
  • Aws\HashingStream
  • Aws\Health\HealthClient
  • Aws\HealthLake\HealthLakeClient
  • Aws\History
  • Aws\Honeycode\HoneycodeClient
  • Aws\Iam\IamClient
  • Aws\IdempotencyTokenMiddleware
  • Aws\IdentityStore\IdentityStoreClient
  • Aws\imagebuilder\imagebuilderClient
  • Aws\ImportExport\ImportExportClient
  • Aws\Inspector2\Inspector2Client
  • Aws\Inspector\InspectorClient
  • Aws\InternetMonitor\InternetMonitorClient
  • Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient
  • Aws\IoT1ClickProjects\IoT1ClickProjectsClient
  • Aws\Iot\IotClient
  • Aws\IoTAnalytics\IoTAnalyticsClient
  • Aws\IotDataPlane\IotDataPlaneClient
  • Aws\IoTDeviceAdvisor\IoTDeviceAdvisorClient
  • Aws\IoTEvents\IoTEventsClient
  • Aws\IoTEventsData\IoTEventsDataClient
  • Aws\IoTFleetHub\IoTFleetHubClient
  • Aws\IoTFleetWise\IoTFleetWiseClient
  • Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient
  • Aws\IoTRoboRunner\IoTRoboRunnerClient
  • Aws\IoTSecureTunneling\IoTSecureTunnelingClient
  • Aws\IoTSiteWise\IoTSiteWiseClient
  • Aws\IoTThingsGraph\IoTThingsGraphClient
  • Aws\IoTTwinMaker\IoTTwinMakerClient
  • Aws\IoTWireless\IoTWirelessClient
  • Aws\IVS\IVSClient
  • Aws\ivschat\ivschatClient
  • Aws\IVSRealTime\IVSRealTimeClient
  • Aws\JsonCompiler
  • Aws\Kafka\KafkaClient
  • Aws\KafkaConnect\KafkaConnectClient
  • Aws\kendra\kendraClient
  • Aws\KendraRanking\KendraRankingClient
  • Aws\Keyspaces\KeyspacesClient
  • Aws\Kinesis\KinesisClient
  • Aws\KinesisAnalytics\KinesisAnalyticsClient
  • Aws\KinesisAnalyticsV2\KinesisAnalyticsV2Client
  • Aws\KinesisVideo\KinesisVideoClient
  • Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient
  • Aws\KinesisVideoMedia\KinesisVideoMediaClient
  • Aws\KinesisVideoSignalingChannels\KinesisVideoSignalingChannelsClient
  • Aws\KinesisVideoWebRTCStorage\KinesisVideoWebRTCStorageClient
  • Aws\Kms\KmsClient
  • Aws\LakeFormation\LakeFormationClient
  • Aws\Lambda\LambdaClient
  • Aws\LexModelBuildingService\LexModelBuildingServiceClient
  • Aws\LexModelsV2\LexModelsV2Client
  • Aws\LexRuntimeService\LexRuntimeServiceClient
  • Aws\LexRuntimeV2\LexRuntimeV2Client
  • Aws\LicenseManager\LicenseManagerClient
  • Aws\LicenseManagerLinuxSubscriptions\LicenseManagerLinuxSubscriptionsClient
  • Aws\LicenseManagerUserSubscriptions\LicenseManagerUserSubscriptionsClient
  • Aws\Lightsail\LightsailClient
  • Aws\LocationService\LocationServiceClient
  • Aws\LookoutEquipment\LookoutEquipmentClient
  • Aws\LookoutforVision\LookoutforVisionClient
  • Aws\LookoutMetrics\LookoutMetricsClient
  • Aws\LruArrayCache
  • Aws\MachineLearning\MachineLearningClient
  • Aws\Macie2\Macie2Client
  • Aws\Macie\MacieClient
  • Aws\MainframeModernization\MainframeModernizationClient
  • Aws\ManagedBlockchain\ManagedBlockchainClient
  • Aws\ManagedGrafana\ManagedGrafanaClient
  • Aws\MarketplaceCatalog\MarketplaceCatalogClient
  • Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient
  • Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient
  • Aws\MarketplaceMetering\MarketplaceMeteringClient
  • Aws\MediaConnect\MediaConnectClient
  • Aws\MediaConvert\MediaConvertClient
  • Aws\MediaLive\MediaLiveClient
  • Aws\MediaPackage\MediaPackageClient
  • Aws\MediaPackageVod\MediaPackageVodClient
  • Aws\MediaStore\MediaStoreClient
  • Aws\MediaStoreData\MediaStoreDataClient
  • Aws\MediaTailor\MediaTailorClient
  • Aws\MemoryDB\MemoryDBClient
  • Aws\mgn\mgnClient
  • Aws\Middleware
  • Aws\MigrationHub\MigrationHubClient
  • Aws\MigrationHubConfig\MigrationHubConfigClient
  • Aws\MigrationHubOrchestrator\MigrationHubOrchestratorClient
  • Aws\MigrationHubRefactorSpaces\MigrationHubRefactorSpacesClient
  • Aws\MigrationHubStrategyRecommendations\MigrationHubStrategyRecommendationsClient
  • Aws\Mobile\MobileClient
  • Aws\MockHandler
  • Aws\MQ\MQClient
  • Aws\MTurk\MTurkClient
  • Aws\Multipart\UploadState
  • Aws\MultiRegionClient
  • Aws\MWAA\MWAAClient
  • Aws\Neptune\NeptuneClient
  • Aws\NetworkFirewall\NetworkFirewallClient
  • Aws\NetworkManager\NetworkManagerClient
  • Aws\NimbleStudio\NimbleStudioClient
  • Aws\OAM\OAMClient
  • Aws\Omics\OmicsClient
  • Aws\OpenSearchServerless\OpenSearchServerlessClient
  • Aws\OpenSearchService\OpenSearchServiceClient
  • Aws\OpsWorks\OpsWorksClient
  • Aws\OpsWorksCM\OpsWorksCMClient
  • Aws\Organizations\OrganizationsClient
  • Aws\Outposts\OutpostsClient
  • Aws\Panorama\PanoramaClient
  • Aws\Personalize\PersonalizeClient
  • Aws\PersonalizeEvents\PersonalizeEventsClient
  • Aws\PersonalizeRuntime\PersonalizeRuntimeClient
  • Aws\PhpHash
  • Aws\PI\PIClient
  • Aws\Pinpoint\PinpointClient
  • Aws\PinpointEmail\PinpointEmailClient
  • Aws\PinpointSMSVoice\PinpointSMSVoiceClient
  • Aws\PinpointSMSVoiceV2\PinpointSMSVoiceV2Client
  • Aws\Pipes\PipesClient
  • Aws\Polly\PollyClient
  • Aws\PresignUrlMiddleware
  • Aws\Pricing\PricingClient
  • Aws\PrivateNetworks\PrivateNetworksClient
  • Aws\PrometheusService\PrometheusServiceClient
  • Aws\Proton\ProtonClient
  • Aws\Psr16CacheAdapter
  • Aws\PsrCacheAdapter
  • Aws\QLDB\QLDBClient
  • Aws\QLDBSession\QLDBSessionClient
  • Aws\QuickSight\QuickSightClient
  • Aws\RAM\RAMClient
  • Aws\Rds\AuthTokenGenerator
  • Aws\Rds\RdsClient
  • Aws\RDSDataService\RDSDataServiceClient
  • Aws\RecycleBin\RecycleBinClient
  • Aws\Redshift\RedshiftClient
  • Aws\RedshiftDataAPIService\RedshiftDataAPIServiceClient
  • Aws\RedshiftServerless\RedshiftServerlessClient
  • Aws\Rekognition\RekognitionClient
  • Aws\ResilienceHub\ResilienceHubClient
  • Aws\ResourceExplorer2\ResourceExplorer2Client
  • Aws\ResourceGroups\ResourceGroupsClient
  • Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient
  • Aws\Result
  • Aws\ResultPaginator
  • Aws\Retry\Configuration
  • Aws\Retry\ConfigurationProvider
  • Aws\RoboMaker\RoboMakerClient
  • Aws\RolesAnywhere\RolesAnywhereClient
  • Aws\Route53\Route53Client
  • Aws\Route53Domains\Route53DomainsClient
  • Aws\Route53RecoveryCluster\Route53RecoveryClusterClient
  • Aws\Route53RecoveryControlConfig\Route53RecoveryControlConfigClient
  • Aws\Route53RecoveryReadiness\Route53RecoveryReadinessClient
  • Aws\Route53Resolver\Route53ResolverClient
  • Aws\S3\BatchDelete
  • Aws\S3\Crypto\HeadersMetadataStrategy
  • Aws\S3\Crypto\InstructionFileMetadataStrategy
  • Aws\S3\Crypto\S3EncryptionClient
  • Aws\S3\Crypto\S3EncryptionClientV2
  • Aws\S3\Crypto\S3EncryptionMultipartUploader
  • Aws\S3\Crypto\S3EncryptionMultipartUploaderV2
  • Aws\S3\GetBucketLocationParser
  • Aws\S3\MultipartUploader
  • Aws\S3\ObjectCopier
  • Aws\S3\ObjectUploader
  • Aws\S3\PostObject
  • Aws\S3\PostObjectV4
  • Aws\S3\RegionalEndpoint\Configuration
  • Aws\S3\RegionalEndpoint\ConfigurationProvider
  • Aws\S3\S3Client
  • Aws\S3\S3MultiRegionClient
  • Aws\S3\S3UriParser
  • Aws\S3\StreamWrapper
  • Aws\S3\Transfer
  • Aws\S3\UseArnRegion\Configuration
  • Aws\S3\UseArnRegion\ConfigurationProvider
  • Aws\S3\ValidateResponseChecksumParser
  • Aws\S3Control\S3ControlClient
  • Aws\S3Outposts\S3OutpostsClient
  • Aws\SageMaker\SageMakerClient
  • Aws\SagemakerEdgeManager\SagemakerEdgeManagerClient
  • Aws\SageMakerFeatureStoreRuntime\SageMakerFeatureStoreRuntimeClient
  • Aws\SageMakerGeospatial\SageMakerGeospatialClient
  • Aws\SageMakerMetrics\SageMakerMetricsClient
  • Aws\SageMakerRuntime\SageMakerRuntimeClient
  • Aws\SavingsPlans\SavingsPlansClient
  • Aws\Scheduler\SchedulerClient
  • Aws\Schemas\SchemasClient
  • Aws\Script\Composer\Composer
  • Aws\Sdk
  • Aws\SecretsManager\SecretsManagerClient
  • Aws\SecurityHub\SecurityHubClient
  • Aws\SecurityLake\SecurityLakeClient
  • Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient
  • Aws\ServiceCatalog\ServiceCatalogClient
  • Aws\ServiceDiscovery\ServiceDiscoveryClient
  • Aws\ServiceQuotas\ServiceQuotasClient
  • Aws\Ses\SesClient
  • Aws\SesV2\SesV2Client
  • Aws\Sfn\SfnClient
  • Aws\Shield\ShieldClient
  • Aws\Signature\AnonymousSignature
  • Aws\Signature\S3SignatureV4
  • Aws\Signature\SignatureProvider
  • Aws\Signature\SignatureV4
  • Aws\signer\signerClient
  • Aws\SimSpaceWeaver\SimSpaceWeaverClient
  • Aws\Sms\SmsClient
  • Aws\SnowBall\SnowBallClient
  • Aws\SnowDeviceManagement\SnowDeviceManagementClient
  • Aws\Sns\Message
  • Aws\Sns\MessageValidator
  • Aws\Sns\SnsClient
  • Aws\Sqs\SqsClient
  • Aws\Ssm\SsmClient
  • Aws\SSMContacts\SSMContactsClient
  • Aws\SSMIncidents\SSMIncidentsClient
  • Aws\SsmSap\SsmSapClient
  • Aws\SSO\SSOClient
  • Aws\SSOAdmin\SSOAdminClient
  • Aws\SSOOIDC\SSOOIDCClient
  • Aws\StorageGateway\StorageGatewayClient
  • Aws\Sts\RegionalEndpoints\Configuration
  • Aws\Sts\RegionalEndpoints\ConfigurationProvider
  • Aws\Sts\StsClient
  • Aws\Support\SupportClient
  • Aws\SupportApp\SupportAppClient
  • Aws\Swf\SwfClient
  • Aws\Synthetics\SyntheticsClient
  • Aws\Textract\TextractClient
  • Aws\TimestreamQuery\TimestreamQueryClient
  • Aws\TimestreamWrite\TimestreamWriteClient
  • Aws\Tnb\TnbClient
  • Aws\Token\BearerTokenAuthorization
  • Aws\Token\SsoToken
  • Aws\Token\SsoTokenProvider
  • Aws\Token\Token
  • Aws\Token\TokenProvider
  • Aws\TraceMiddleware
  • Aws\TranscribeService\TranscribeServiceClient
  • Aws\Transfer\TransferClient
  • Aws\Translate\TranslateClient
  • Aws\VoiceID\VoiceIDClient
  • Aws\Waf\WafClient
  • Aws\WafRegional\WafRegionalClient
  • Aws\WAFV2\WAFV2Client
  • Aws\Waiter
  • Aws\WellArchitected\WellArchitectedClient
  • Aws\WorkDocs\WorkDocsClient
  • Aws\WorkLink\WorkLinkClient
  • Aws\WorkMail\WorkMailClient
  • Aws\WorkMailMessageFlow\WorkMailMessageFlowClient
  • Aws\WorkSpaces\WorkSpacesClient
  • Aws\WorkSpacesWeb\WorkSpacesWebClient
  • Aws\WrappedHttpHandler
  • Aws\XRay\XRayClient

Interfaces

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

Traits

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

Exceptions

  • Aws\AccessAnalyzer\Exception\AccessAnalyzerException
  • Aws\Account\Exception\AccountException
  • Aws\Acm\Exception\AcmException
  • Aws\ACMPCA\Exception\ACMPCAException
  • Aws\AlexaForBusiness\Exception\AlexaForBusinessException
  • Aws\Amplify\Exception\AmplifyException
  • Aws\AmplifyBackend\Exception\AmplifyBackendException
  • Aws\AmplifyUIBuilder\Exception\AmplifyUIBuilderException
  • Aws\Api\Parser\Exception\ParserException
  • Aws\ApiGateway\Exception\ApiGatewayException
  • Aws\ApiGatewayManagementApi\Exception\ApiGatewayManagementApiException
  • Aws\ApiGatewayV2\Exception\ApiGatewayV2Exception
  • Aws\AppConfig\Exception\AppConfigException
  • Aws\AppConfigData\Exception\AppConfigDataException
  • Aws\Appflow\Exception\AppflowException
  • Aws\AppIntegrationsService\Exception\AppIntegrationsServiceException
  • Aws\ApplicationAutoScaling\Exception\ApplicationAutoScalingException
  • Aws\ApplicationCostProfiler\Exception\ApplicationCostProfilerException
  • Aws\ApplicationDiscoveryService\Exception\ApplicationDiscoveryServiceException
  • Aws\ApplicationInsights\Exception\ApplicationInsightsException
  • Aws\AppMesh\Exception\AppMeshException
  • Aws\AppRegistry\Exception\AppRegistryException
  • Aws\AppRunner\Exception\AppRunnerException
  • Aws\Appstream\Exception\AppstreamException
  • Aws\AppSync\Exception\AppSyncException
  • Aws\ARCZonalShift\Exception\ARCZonalShiftException
  • Aws\Arn\Exception\InvalidArnException
  • Aws\Athena\Exception\AthenaException
  • Aws\AuditManager\Exception\AuditManagerException
  • Aws\AugmentedAIRuntime\Exception\AugmentedAIRuntimeException
  • Aws\AutoScaling\Exception\AutoScalingException
  • Aws\AutoScalingPlans\Exception\AutoScalingPlansException
  • Aws\Backup\Exception\BackupException
  • Aws\BackupGateway\Exception\BackupGatewayException
  • Aws\BackupStorage\Exception\BackupStorageException
  • Aws\Batch\Exception\BatchException
  • Aws\BillingConductor\Exception\BillingConductorException
  • Aws\Braket\Exception\BraketException
  • Aws\Budgets\Exception\BudgetsException
  • Aws\Chime\Exception\ChimeException
  • Aws\ChimeSDKIdentity\Exception\ChimeSDKIdentityException
  • Aws\ChimeSDKMediaPipelines\Exception\ChimeSDKMediaPipelinesException
  • Aws\ChimeSDKMeetings\Exception\ChimeSDKMeetingsException
  • Aws\ChimeSDKMessaging\Exception\ChimeSDKMessagingException
  • Aws\ChimeSDKVoice\Exception\ChimeSDKVoiceException
  • Aws\CleanRooms\Exception\CleanRoomsException
  • Aws\ClientSideMonitoring\Exception\ConfigurationException
  • Aws\Cloud9\Exception\Cloud9Exception
  • Aws\CloudControlApi\Exception\CloudControlApiException
  • Aws\CloudDirectory\Exception\CloudDirectoryException
  • Aws\CloudFormation\Exception\CloudFormationException
  • Aws\CloudFront\Exception\CloudFrontException
  • Aws\CloudHsm\Exception\CloudHsmException
  • Aws\CloudHSMV2\Exception\CloudHSMV2Exception
  • Aws\CloudSearch\Exception\CloudSearchException
  • Aws\CloudSearchDomain\Exception\CloudSearchDomainException
  • Aws\CloudTrail\Exception\CloudTrailException
  • Aws\CloudTrailData\Exception\CloudTrailDataException
  • Aws\CloudWatch\Exception\CloudWatchException
  • Aws\CloudWatchEvents\Exception\CloudWatchEventsException
  • Aws\CloudWatchEvidently\Exception\CloudWatchEvidentlyException
  • Aws\CloudWatchLogs\Exception\CloudWatchLogsException
  • Aws\CloudWatchRUM\Exception\CloudWatchRUMException
  • Aws\CodeArtifact\Exception\CodeArtifactException
  • Aws\CodeBuild\Exception\CodeBuildException
  • Aws\CodeCatalyst\Exception\CodeCatalystException
  • Aws\CodeCommit\Exception\CodeCommitException
  • Aws\CodeDeploy\Exception\CodeDeployException
  • Aws\CodeGuruProfiler\Exception\CodeGuruProfilerException
  • Aws\CodeGuruReviewer\Exception\CodeGuruReviewerException
  • Aws\CodePipeline\Exception\CodePipelineException
  • Aws\CodeStar\Exception\CodeStarException
  • Aws\CodeStarconnections\Exception\CodeStarconnectionsException
  • Aws\CodeStarNotifications\Exception\CodeStarNotificationsException
  • Aws\CognitoIdentity\Exception\CognitoIdentityException
  • Aws\CognitoIdentityProvider\Exception\CognitoIdentityProviderException
  • Aws\CognitoSync\Exception\CognitoSyncException
  • Aws\Comprehend\Exception\ComprehendException
  • Aws\ComprehendMedical\Exception\ComprehendMedicalException
  • Aws\ComputeOptimizer\Exception\ComputeOptimizerException
  • Aws\ConfigService\Exception\ConfigServiceException
  • Aws\Connect\Exception\ConnectException
  • Aws\ConnectCampaignService\Exception\ConnectCampaignServiceException
  • Aws\ConnectCases\Exception\ConnectCasesException
  • Aws\ConnectContactLens\Exception\ConnectContactLensException
  • Aws\ConnectParticipant\Exception\ConnectParticipantException
  • Aws\ConnectWisdomService\Exception\ConnectWisdomServiceException
  • Aws\ControlTower\Exception\ControlTowerException
  • Aws\CostandUsageReportService\Exception\CostandUsageReportServiceException
  • Aws\CostExplorer\Exception\CostExplorerException
  • Aws\CustomerProfiles\Exception\CustomerProfilesException
  • Aws\DatabaseMigrationService\Exception\DatabaseMigrationServiceException
  • Aws\DataExchange\Exception\DataExchangeException
  • Aws\DataPipeline\Exception\DataPipelineException
  • Aws\DataSync\Exception\DataSyncException
  • Aws\DAX\Exception\DAXException
  • Aws\DefaultsMode\Exception\ConfigurationException
  • Aws\Detective\Exception\DetectiveException
  • Aws\DeviceFarm\Exception\DeviceFarmException
  • Aws\DevOpsGuru\Exception\DevOpsGuruException
  • Aws\DirectConnect\Exception\DirectConnectException
  • Aws\DirectoryService\Exception\DirectoryServiceException
  • Aws\DLM\Exception\DLMException
  • Aws\DocDB\Exception\DocDBException
  • Aws\DocDBElastic\Exception\DocDBElasticException
  • Aws\drs\Exception\drsException
  • Aws\DynamoDb\Exception\DynamoDbException
  • Aws\DynamoDbStreams\Exception\DynamoDbStreamsException
  • Aws\EBS\Exception\EBSException
  • Aws\Ec2\Exception\Ec2Exception
  • Aws\EC2InstanceConnect\Exception\EC2InstanceConnectException
  • Aws\Ecr\Exception\EcrException
  • Aws\ECRPublic\Exception\ECRPublicException
  • Aws\Ecs\Exception\EcsException
  • Aws\Efs\Exception\EfsException
  • Aws\EKS\Exception\EKSException
  • Aws\ElastiCache\Exception\ElastiCacheException
  • Aws\ElasticBeanstalk\Exception\ElasticBeanstalkException
  • Aws\ElasticInference\Exception\ElasticInferenceException
  • Aws\ElasticLoadBalancing\Exception\ElasticLoadBalancingException
  • Aws\ElasticLoadBalancingV2\Exception\ElasticLoadBalancingV2Exception
  • Aws\ElasticsearchService\Exception\ElasticsearchServiceException
  • Aws\ElasticTranscoder\Exception\ElasticTranscoderException
  • Aws\Emr\Exception\EmrException
  • Aws\EMRContainers\Exception\EMRContainersException
  • Aws\EMRServerless\Exception\EMRServerlessException
  • Aws\Endpoint\UseDualstackEndpoint\Exception\ConfigurationException
  • Aws\Endpoint\UseFipsEndpoint\Exception\ConfigurationException
  • Aws\EndpointDiscovery\Exception\ConfigurationException
  • Aws\EventBridge\Exception\EventBridgeException
  • Aws\Exception\AwsException
  • Aws\Exception\CommonRuntimeException
  • Aws\Exception\CouldNotCreateChecksumException
  • Aws\Exception\CredentialsException
  • Aws\Exception\CryptoException
  • Aws\Exception\CryptoPolyfillException
  • Aws\Exception\EventStreamDataException
  • Aws\Exception\IncalculablePayloadException
  • Aws\Exception\InvalidJsonException
  • Aws\Exception\InvalidRegionException
  • Aws\Exception\MultipartUploadException
  • Aws\Exception\TokenException
  • Aws\Exception\UnresolvedApiException
  • Aws\Exception\UnresolvedEndpointException
  • Aws\Exception\UnresolvedSignatureException
  • Aws\finspace\Exception\finspaceException
  • Aws\FinSpaceData\Exception\FinSpaceDataException
  • Aws\Firehose\Exception\FirehoseException
  • Aws\FIS\Exception\FISException
  • Aws\FMS\Exception\FMSException
  • Aws\ForecastQueryService\Exception\ForecastQueryServiceException
  • Aws\ForecastService\Exception\ForecastServiceException
  • Aws\FraudDetector\Exception\FraudDetectorException
  • Aws\FSx\Exception\FSxException
  • Aws\GameLift\Exception\GameLiftException
  • Aws\GameSparks\Exception\GameSparksException
  • Aws\Glacier\Exception\GlacierException
  • Aws\GlobalAccelerator\Exception\GlobalAcceleratorException
  • Aws\Glue\Exception\GlueException
  • Aws\GlueDataBrew\Exception\GlueDataBrewException
  • Aws\Greengrass\Exception\GreengrassException
  • Aws\GreengrassV2\Exception\GreengrassV2Exception
  • Aws\GroundStation\Exception\GroundStationException
  • Aws\GuardDuty\Exception\GuardDutyException
  • Aws\Health\Exception\HealthException
  • Aws\HealthLake\Exception\HealthLakeException
  • Aws\Honeycode\Exception\HoneycodeException
  • Aws\Iam\Exception\IamException
  • Aws\IdentityStore\Exception\IdentityStoreException
  • Aws\imagebuilder\Exception\imagebuilderException
  • Aws\ImportExport\Exception\ImportExportException
  • Aws\Inspector2\Exception\Inspector2Exception
  • Aws\Inspector\Exception\InspectorException
  • Aws\InternetMonitor\Exception\InternetMonitorException
  • Aws\IoT1ClickDevicesService\Exception\IoT1ClickDevicesServiceException
  • Aws\IoT1ClickProjects\Exception\IoT1ClickProjectsException
  • Aws\Iot\Exception\IotException
  • Aws\IoTAnalytics\Exception\IoTAnalyticsException
  • Aws\IotDataPlane\Exception\IotDataPlaneException
  • Aws\IoTDeviceAdvisor\Exception\IoTDeviceAdvisorException
  • Aws\IoTEvents\Exception\IoTEventsException
  • Aws\IoTEventsData\Exception\IoTEventsDataException
  • Aws\IoTFleetHub\Exception\IoTFleetHubException
  • Aws\IoTFleetWise\Exception\IoTFleetWiseException
  • Aws\IoTJobsDataPlane\Exception\IoTJobsDataPlaneException
  • Aws\IoTRoboRunner\Exception\IoTRoboRunnerException
  • Aws\IoTSecureTunneling\Exception\IoTSecureTunnelingException
  • Aws\IoTSiteWise\Exception\IoTSiteWiseException
  • Aws\IoTThingsGraph\Exception\IoTThingsGraphException
  • Aws\IoTTwinMaker\Exception\IoTTwinMakerException
  • Aws\IoTWireless\Exception\IoTWirelessException
  • Aws\IVS\Exception\IVSException
  • Aws\ivschat\Exception\ivschatException
  • Aws\IVSRealTime\Exception\IVSRealTimeException
  • Aws\Kafka\Exception\KafkaException
  • Aws\KafkaConnect\Exception\KafkaConnectException
  • Aws\kendra\Exception\kendraException
  • Aws\KendraRanking\Exception\KendraRankingException
  • Aws\Keyspaces\Exception\KeyspacesException
  • Aws\Kinesis\Exception\KinesisException
  • Aws\KinesisAnalytics\Exception\KinesisAnalyticsException
  • Aws\KinesisAnalyticsV2\Exception\KinesisAnalyticsV2Exception
  • Aws\KinesisVideo\Exception\KinesisVideoException
  • Aws\KinesisVideoArchivedMedia\Exception\KinesisVideoArchivedMediaException
  • Aws\KinesisVideoMedia\Exception\KinesisVideoMediaException
  • Aws\KinesisVideoSignalingChannels\Exception\KinesisVideoSignalingChannelsException
  • Aws\KinesisVideoWebRTCStorage\Exception\KinesisVideoWebRTCStorageException
  • Aws\Kms\Exception\KmsException
  • Aws\LakeFormation\Exception\LakeFormationException
  • Aws\Lambda\Exception\LambdaException
  • Aws\LexModelBuildingService\Exception\LexModelBuildingServiceException
  • Aws\LexModelsV2\Exception\LexModelsV2Exception
  • Aws\LexRuntimeService\Exception\LexRuntimeServiceException
  • Aws\LexRuntimeV2\Exception\LexRuntimeV2Exception
  • Aws\LicenseManager\Exception\LicenseManagerException
  • Aws\LicenseManagerLinuxSubscriptions\Exception\LicenseManagerLinuxSubscriptionsException
  • Aws\LicenseManagerUserSubscriptions\Exception\LicenseManagerUserSubscriptionsException
  • Aws\Lightsail\Exception\LightsailException
  • Aws\LocationService\Exception\LocationServiceException
  • Aws\LookoutEquipment\Exception\LookoutEquipmentException
  • Aws\LookoutforVision\Exception\LookoutforVisionException
  • Aws\LookoutMetrics\Exception\LookoutMetricsException
  • Aws\MachineLearning\Exception\MachineLearningException
  • Aws\Macie2\Exception\Macie2Exception
  • Aws\Macie\Exception\MacieException
  • Aws\MainframeModernization\Exception\MainframeModernizationException
  • Aws\ManagedBlockchain\Exception\ManagedBlockchainException
  • Aws\ManagedGrafana\Exception\ManagedGrafanaException
  • Aws\MarketplaceCatalog\Exception\MarketplaceCatalogException
  • Aws\MarketplaceCommerceAnalytics\Exception\MarketplaceCommerceAnalyticsException
  • Aws\MarketplaceEntitlementService\Exception\MarketplaceEntitlementServiceException
  • Aws\MarketplaceMetering\Exception\MarketplaceMeteringException
  • Aws\MediaConnect\Exception\MediaConnectException
  • Aws\MediaConvert\Exception\MediaConvertException
  • Aws\MediaLive\Exception\MediaLiveException
  • Aws\MediaPackage\Exception\MediaPackageException
  • Aws\MediaPackageVod\Exception\MediaPackageVodException
  • Aws\MediaStore\Exception\MediaStoreException
  • Aws\MediaStoreData\Exception\MediaStoreDataException
  • Aws\MediaTailor\Exception\MediaTailorException
  • Aws\MemoryDB\Exception\MemoryDBException
  • Aws\mgn\Exception\mgnException
  • Aws\MigrationHub\Exception\MigrationHubException
  • Aws\MigrationHubConfig\Exception\MigrationHubConfigException
  • Aws\MigrationHubOrchestrator\Exception\MigrationHubOrchestratorException
  • Aws\MigrationHubRefactorSpaces\Exception\MigrationHubRefactorSpacesException
  • Aws\MigrationHubStrategyRecommendations\Exception\MigrationHubStrategyRecommendationsException
  • Aws\Mobile\Exception\MobileException
  • Aws\MQ\Exception\MQException
  • Aws\MTurk\Exception\MTurkException
  • Aws\MWAA\Exception\MWAAException
  • Aws\Neptune\Exception\NeptuneException
  • Aws\NetworkFirewall\Exception\NetworkFirewallException
  • Aws\NetworkManager\Exception\NetworkManagerException
  • Aws\NimbleStudio\Exception\NimbleStudioException
  • Aws\OAM\Exception\OAMException
  • Aws\Omics\Exception\OmicsException
  • Aws\OpenSearchServerless\Exception\OpenSearchServerlessException
  • Aws\OpenSearchService\Exception\OpenSearchServiceException
  • Aws\OpsWorks\Exception\OpsWorksException
  • Aws\OpsWorksCM\Exception\OpsWorksCMException
  • Aws\Organizations\Exception\OrganizationsException
  • Aws\Outposts\Exception\OutpostsException
  • Aws\Panorama\Exception\PanoramaException
  • Aws\Personalize\Exception\PersonalizeException
  • Aws\PersonalizeEvents\Exception\PersonalizeEventsException
  • Aws\PersonalizeRuntime\Exception\PersonalizeRuntimeException
  • Aws\PI\Exception\PIException
  • Aws\Pinpoint\Exception\PinpointException
  • Aws\PinpointEmail\Exception\PinpointEmailException
  • Aws\PinpointSMSVoice\Exception\PinpointSMSVoiceException
  • Aws\PinpointSMSVoiceV2\Exception\PinpointSMSVoiceV2Exception
  • Aws\Pipes\Exception\PipesException
  • Aws\Polly\Exception\PollyException
  • Aws\Pricing\Exception\PricingException
  • Aws\PrivateNetworks\Exception\PrivateNetworksException
  • Aws\PrometheusService\Exception\PrometheusServiceException
  • Aws\Proton\Exception\ProtonException
  • Aws\QLDB\Exception\QLDBException
  • Aws\QLDBSession\Exception\QLDBSessionException
  • Aws\QuickSight\Exception\QuickSightException
  • Aws\RAM\Exception\RAMException
  • Aws\Rds\Exception\RdsException
  • Aws\RDSDataService\Exception\RDSDataServiceException
  • Aws\RecycleBin\Exception\RecycleBinException
  • Aws\Redshift\Exception\RedshiftException
  • Aws\RedshiftDataAPIService\Exception\RedshiftDataAPIServiceException
  • Aws\RedshiftServerless\Exception\RedshiftServerlessException
  • Aws\Rekognition\Exception\RekognitionException
  • Aws\ResilienceHub\Exception\ResilienceHubException
  • Aws\ResourceExplorer2\Exception\ResourceExplorer2Exception
  • Aws\ResourceGroups\Exception\ResourceGroupsException
  • Aws\ResourceGroupsTaggingAPI\Exception\ResourceGroupsTaggingAPIException
  • Aws\Retry\Exception\ConfigurationException
  • Aws\RoboMaker\Exception\RoboMakerException
  • Aws\RolesAnywhere\Exception\RolesAnywhereException
  • Aws\Route53\Exception\Route53Exception
  • Aws\Route53Domains\Exception\Route53DomainsException
  • Aws\Route53RecoveryCluster\Exception\Route53RecoveryClusterException
  • Aws\Route53RecoveryControlConfig\Exception\Route53RecoveryControlConfigException
  • Aws\Route53RecoveryReadiness\Exception\Route53RecoveryReadinessException
  • Aws\Route53Resolver\Exception\Route53ResolverException
  • Aws\S3\Exception\DeleteMultipleObjectsException
  • Aws\S3\Exception\PermanentRedirectException
  • Aws\S3\Exception\S3Exception
  • Aws\S3\Exception\S3MultipartUploadException
  • Aws\S3\RegionalEndpoint\Exception\ConfigurationException
  • Aws\S3\UseArnRegion\Exception\ConfigurationException
  • Aws\S3Control\Exception\S3ControlException
  • Aws\S3Outposts\Exception\S3OutpostsException
  • Aws\SageMaker\Exception\SageMakerException
  • Aws\SagemakerEdgeManager\Exception\SagemakerEdgeManagerException
  • Aws\SageMakerFeatureStoreRuntime\Exception\SageMakerFeatureStoreRuntimeException
  • Aws\SageMakerGeospatial\Exception\SageMakerGeospatialException
  • Aws\SageMakerMetrics\Exception\SageMakerMetricsException
  • Aws\SageMakerRuntime\Exception\SageMakerRuntimeException
  • Aws\SavingsPlans\Exception\SavingsPlansException
  • Aws\Scheduler\Exception\SchedulerException
  • Aws\Schemas\Exception\SchemasException
  • Aws\SecretsManager\Exception\SecretsManagerException
  • Aws\SecurityHub\Exception\SecurityHubException
  • Aws\SecurityLake\Exception\SecurityLakeException
  • Aws\ServerlessApplicationRepository\Exception\ServerlessApplicationRepositoryException
  • Aws\ServiceCatalog\Exception\ServiceCatalogException
  • Aws\ServiceDiscovery\Exception\ServiceDiscoveryException
  • Aws\ServiceQuotas\Exception\ServiceQuotasException
  • Aws\Ses\Exception\SesException
  • Aws\SesV2\Exception\SesV2Exception
  • Aws\Sfn\Exception\SfnException
  • Aws\Shield\Exception\ShieldException
  • Aws\signer\Exception\signerException
  • Aws\SimSpaceWeaver\Exception\SimSpaceWeaverException
  • Aws\Sms\Exception\SmsException
  • Aws\SnowBall\Exception\SnowBallException
  • Aws\SnowDeviceManagement\Exception\SnowDeviceManagementException
  • Aws\Sns\Exception\InvalidSnsMessageException
  • Aws\Sns\Exception\SnsException
  • Aws\Sqs\Exception\SqsException
  • Aws\Ssm\Exception\SsmException
  • Aws\SSMContacts\Exception\SSMContactsException
  • Aws\SSMIncidents\Exception\SSMIncidentsException
  • Aws\SsmSap\Exception\SsmSapException
  • Aws\SSO\Exception\SSOException
  • Aws\SSOAdmin\Exception\SSOAdminException
  • Aws\SSOOIDC\Exception\SSOOIDCException
  • Aws\StorageGateway\Exception\StorageGatewayException
  • Aws\Sts\Exception\StsException
  • Aws\Sts\RegionalEndpoints\Exception\ConfigurationException
  • Aws\Support\Exception\SupportException
  • Aws\SupportApp\Exception\SupportAppException
  • Aws\Swf\Exception\SwfException
  • Aws\Synthetics\Exception\SyntheticsException
  • Aws\Textract\Exception\TextractException
  • Aws\TimestreamQuery\Exception\TimestreamQueryException
  • Aws\TimestreamWrite\Exception\TimestreamWriteException
  • Aws\Tnb\Exception\TnbException
  • Aws\TranscribeService\Exception\TranscribeServiceException
  • Aws\Transfer\Exception\TransferException
  • Aws\Translate\Exception\TranslateException
  • Aws\VoiceID\Exception\VoiceIDException
  • Aws\Waf\Exception\WafException
  • Aws\WafRegional\Exception\WafRegionalException
  • Aws\WAFV2\Exception\WAFV2Exception
  • Aws\WellArchitected\Exception\WellArchitectedException
  • Aws\WorkDocs\Exception\WorkDocsException
  • Aws\WorkLink\Exception\WorkLinkException
  • Aws\WorkMail\Exception\WorkMailException
  • Aws\WorkMailMessageFlow\Exception\WorkMailMessageFlowException
  • Aws\WorkSpaces\Exception\WorkSpacesException
  • Aws\WorkSpacesWeb\Exception\WorkSpacesWebException
  • Aws\XRay\Exception\XRayException

Functions

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

AWS 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 */).

  • AcceptAttachment ( array $params = [] )

    Accepts a core network attachment request.

  • AssociateConnectPeer ( array $params = [] )

    Associates a core network Connect peer with a device and optionally, with a link.

  • 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.

  • CreateConnectAttachment ( array $params = [] )

    Creates a core network Connect attachment from a specified core network attachment.

  • CreateConnectPeer ( array $params = [] )

    Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.

  • CreateConnection ( array $params = [] )

    Creates a connection between two devices.

  • CreateCoreNetwork ( array $params = [] )

    Creates a core network as part of your global network, and optionally, with a core network policy.

  • 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.

  • CreateSiteToSiteVpnAttachment ( array $params = [] )

    Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

  • CreateTransitGatewayPeering ( array $params = [] )

    Creates a transit gateway peering connection.

  • CreateTransitGatewayRouteTableAttachment ( array $params = [] )

    Creates a transit gateway route table attachment.

  • CreateVpcAttachment ( array $params = [] )

    Creates a VPC attachment on an edge location of a core network.

  • DeleteAttachment ( array $params = [] )

    Deletes an attachment.

  • DeleteConnectPeer ( array $params = [] )

    Deletes a Connect peer.

  • DeleteConnection ( array $params = [] )

    Deletes the specified connection in your global network.

  • DeleteCoreNetwork ( array $params = [] )

    Deletes a core network along with all core network policies.

  • DeleteCoreNetworkPolicyVersion ( array $params = [] )

    Deletes a policy version from a core network.

  • DeleteDevice ( array $params = [] )

    Deletes an existing device.

  • DeleteGlobalNetwork ( array $params = [] )

    Deletes an existing global network.

  • DeleteLink ( array $params = [] )

    Deletes an existing link.

  • DeletePeering ( array $params = [] )

    Deletes an existing peering connection.

  • DeleteResourcePolicy ( array $params = [] )

    Deletes a resource policy for the specified resource.

  • 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.

  • DisassociateConnectPeer ( array $params = [] )

    Disassociates a core network Connect peer from a device and a link.

  • 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.

  • ExecuteCoreNetworkChangeSet ( array $params = [] )

    Executes a change set on your core network.

  • GetConnectAttachment ( array $params = [] )

    Returns information about a core network Connect attachment.

  • GetConnectPeer ( array $params = [] )

    Returns information about a core network Connect peer.

  • GetConnectPeerAssociations ( array $params = [] )

    Returns information about a core network Connect peer associations.

  • GetConnections ( array $params = [] )

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

  • GetCoreNetwork ( array $params = [] )

    Returns information about the LIVE policy for a core network.

  • GetCoreNetworkChangeEvents ( array $params = [] )

    Returns information about a core network change event.

  • GetCoreNetworkChangeSet ( array $params = [] )

    Returns a change set between the LIVE core network policy and a submitted policy.

  • GetCoreNetworkPolicy ( array $params = [] )

    Returns details about a core network policy.

  • 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.

  • GetNetworkResourceCounts ( array $params = [] )

    Gets the count of network resources, by resource type, for the specified global network.

  • GetNetworkResourceRelationships ( array $params = [] )

    Gets the network resource relationships for the specified global network.

  • GetNetworkResources ( array $params = [] )

    Describes the network resources for the specified global network.

  • GetNetworkRoutes ( array $params = [] )

    Gets the network routes of the specified global network.

  • GetNetworkTelemetry ( array $params = [] )

    Gets the network telemetry of the specified global network.

  • GetResourcePolicy ( array $params = [] )

    Returns information about a resource policy.

  • GetRouteAnalysis ( array $params = [] )

    Gets information about the specified route analysis.

  • GetSiteToSiteVpnAttachment ( array $params = [] )

    Returns information about a site-to-site VPN attachment.

  • 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.

  • GetTransitGatewayPeering ( array $params = [] )

    Returns information about a transit gateway peer.

  • GetTransitGatewayRegistrations ( array $params = [] )

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

  • GetTransitGatewayRouteTableAttachment ( array $params = [] )

    Returns information about a transit gateway route table attachment.

  • GetVpcAttachment ( array $params = [] )

    Returns information about a VPC attachment.

  • ListAttachments ( array $params = [] )

    Returns a list of core network attachments.

  • ListConnectPeers ( array $params = [] )

    Returns a list of core network Connect peers.

  • ListCoreNetworkPolicyVersions ( array $params = [] )

    Returns a list of core network policy versions.

  • ListCoreNetworks ( array $params = [] )

    Returns a list of owned and shared core networks.

  • ListOrganizationServiceAccessStatus ( array $params = [] )

    Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

  • ListPeerings ( array $params = [] )

    Lists the peerings for a core network.

  • ListTagsForResource ( array $params = [] )

    Lists the tags for a specified resource.

  • PutCoreNetworkPolicy ( array $params = [] )

    Creates a new, immutable version of a core network policy.

  • PutResourcePolicy ( array $params = [] )

    Creates or updates a resource policy.

  • RegisterTransitGateway ( array $params = [] )

    Registers a transit gateway in your global network.

  • RejectAttachment ( array $params = [] )

    Rejects a core network attachment request.

  • RestoreCoreNetworkPolicyVersion ( array $params = [] )

    Restores a previous policy version as a new, immutable version of a core network policy.

  • StartOrganizationServiceAccessUpdate ( array $params = [] )

    Enables the Network Manager service for an Amazon Web Services Organization.

  • StartRouteAnalysis ( array $params = [] )

    Starts analyzing the routing path between the specified source and destination.

  • 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.

  • UpdateCoreNetwork ( array $params = [] )

    Updates the description of a core network.

  • 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.

  • UpdateNetworkResourceMetadata ( array $params = [] )

    Updates the resource metadata for the specified global network.

  • UpdateSite ( array $params = [] )

    Updates the information for an existing site.

  • UpdateVpcAttachment ( array $params = [] )

    Updates a VPC attachment.

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
  • GetConnectPeerAssociations
  • GetConnections
  • GetCoreNetworkChangeEvents
  • GetCoreNetworkChangeSet
  • GetCustomerGatewayAssociations
  • GetDevices
  • GetLinkAssociations
  • GetLinks
  • GetNetworkResourceCounts
  • GetNetworkResourceRelationships
  • GetNetworkResources
  • GetNetworkTelemetry
  • GetSites
  • GetTransitGatewayConnectPeerAssociations
  • GetTransitGatewayRegistrations
  • ListAttachments
  • ListConnectPeers
  • ListCoreNetworkPolicyVersions
  • ListCoreNetworks
  • ListPeerings

Operations

AcceptAttachment

$result = $client->acceptAttachment([/* ... */]);
$promise = $client->acceptAttachmentAsync([/* ... */]);

Accepts a core network attachment request.

Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Result Syntax

[
    'Attachment' => [
        'AttachmentId' => '<string>',
        'AttachmentPolicyRuleNumber' => <integer>,
        'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProposedSegmentChange' => [
            'AttachmentPolicyRuleNumber' => <integer>,
            'SegmentName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'ResourceArn' => '<string>',
        'SegmentName' => '<string>',
        'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Members
Attachment
  • Type: Attachment structure

The response to the attachment request.

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.

AssociateConnectPeer

$result = $client->associateConnectPeer([/* ... */]);
$promise = $client->associateConnectPeerAsync([/* ... */]);

Associates a core network 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 core network Connect peers that have been created on a core network Connect attachment on a core network.

Parameter Syntax

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

Parameter Details

Members
ConnectPeerId
  • Required: Yes
  • Type: string

The ID of the Connect peer.

DeviceId
  • Required: Yes
  • Type: string

The ID of the device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of your global network.

LinkId
  • Type: string

The ID of the link.

Result Syntax

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

Result Details

Members
ConnectPeerAssociation
  • Type: ConnectPeerAssociation structure

The response to the Connect peer request.

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.

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 or core network registered in your global network. When you register a transit gateway or core network, 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.

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.

CreateConnectAttachment

$result = $client->createConnectAttachment([/* ... */]);
$promise = $client->createConnectAttachmentAsync([/* ... */]);

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

Parameter Syntax

$result = $client->createConnectAttachment([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'EdgeLocation' => '<string>', // REQUIRED
    'Options' => [ // REQUIRED
        'Protocol' => 'GRE',
    ],
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransportAttachmentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network where you want to create the attachment.

EdgeLocation
  • Required: Yes
  • Type: string

The Region where the edge is located.

Options
  • Required: Yes
  • Type: ConnectAttachmentOptions structure

Options for creating an attachment.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the request.

TransportAttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment between the two connections.

Result Syntax

[
    'ConnectAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'Options' => [
            'Protocol' => 'GRE',
        ],
        'TransportAttachmentId' => '<string>',
    ],
]

Result Details

Members
ConnectAttachment
  • Type: ConnectAttachment structure

The response to a Connect attachment request.

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.

CreateConnectPeer

$result = $client->createConnectPeer([/* ... */]);
$promise = $client->createConnectPeerAsync([/* ... */]);

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

Parameter Syntax

$result = $client->createConnectPeer([
    'BgpOptions' => [
        'PeerAsn' => <integer>,
    ],
    'ClientToken' => '<string>',
    'ConnectAttachmentId' => '<string>', // REQUIRED
    'CoreNetworkAddress' => '<string>',
    'InsideCidrBlocks' => ['<string>', ...], // REQUIRED
    'PeerAddress' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
BgpOptions
  • Type: BgpOptions structure

The Connect peer BGP options.

ClientToken
  • Type: string

The client token associated with the request.

ConnectAttachmentId
  • Required: Yes
  • Type: string

The ID of the connection attachment.

CoreNetworkAddress
  • Type: string

A Connect peer core network address.

InsideCidrBlocks
  • Required: Yes
  • Type: Array of strings

The inside IP addresses used for BGP peering.

PeerAddress
  • Required: Yes
  • Type: string

The Connect peer address.

Tags
  • Type: Array of Tag structures

The tags associated with the peer request.

Result Syntax

[
    'ConnectPeer' => [
        'Configuration' => [
            'BgpConfigurations' => [
                [
                    'CoreNetworkAddress' => '<string>',
                    'CoreNetworkAsn' => <integer>,
                    'PeerAddress' => '<string>',
                    'PeerAsn' => <integer>,
                ],
                // ...
            ],
            'CoreNetworkAddress' => '<string>',
            'InsideCidrBlocks' => ['<string>', ...],
            'PeerAddress' => '<string>',
            'Protocol' => 'GRE',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ConnectPeer
  • Type: ConnectPeer structure

The response to the request.

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.

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.

CreateCoreNetwork

$result = $client->createCoreNetwork([/* ... */]);
$promise = $client->createCoreNetworkAsync([/* ... */]);

Creates a core network as part of your global network, and optionally, with a core network policy.

Parameter Syntax

$result = $client->createCoreNetwork([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'PolicyDocument' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with a core network request.

Description
  • Type: string

The description of a core network.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network that a core network will be a part of.

PolicyDocument
  • Type: string

The policy document for creating a core network.

Tags
  • Type: Array of Tag structures

Key-value tags associated with a core network request.

Result Syntax

[
    'CoreNetwork' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Edges' => [
            [
                'Asn' => <integer>,
                'EdgeLocation' => '<string>',
                'InsideCidrBlocks' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalNetworkId' => '<string>',
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
CoreNetwork
  • Type: CoreNetwork structure

Returns details about a core network.

Errors

  • CoreNetworkPolicyException:

    Describes a core network policy exception.

  • 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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

Description
  • Type: string

A description of the device.

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.

Constraints: Maximum length of 128 characters.

SerialNumber
  • Type: string

The serial number of the device.

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.

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.

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.

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: Maximum length of 128 characters. Cannot include the following 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: Maximum length of 128 characters. Cannot include the following 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.

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.

CreateSiteToSiteVpnAttachment

$result = $client->createSiteToSiteVpnAttachment([/* ... */]);
$promise = $client->createSiteToSiteVpnAttachmentAsync([/* ... */]);

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

Parameter Syntax

$result = $client->createSiteToSiteVpnAttachment([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpnConnectionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network where you're creating a site-to-site VPN attachment.

Tags
  • Type: Array of Tag structures

The tags associated with the request.

VpnConnectionArn
  • Required: Yes
  • Type: string

The ARN identifying the VPN attachment.

Result Syntax

[
    'SiteToSiteVpnAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'VpnConnectionArn' => '<string>',
    ],
]

Result Details

Members
SiteToSiteVpnAttachment
  • Type: SiteToSiteVpnAttachment structure

Details about a site-to-site VPN attachment.

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.

CreateTransitGatewayPeering

$result = $client->createTransitGatewayPeering([/* ... */]);
$promise = $client->createTransitGatewayPeeringAsync([/* ... */]);

Creates a transit gateway peering connection.

Parameter Syntax

$result = $client->createTransitGatewayPeering([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitGatewayArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the request.

TransitGatewayArn
  • Required: Yes
  • Type: string

The ARN of the transit gateway for the peering request.

Result Syntax

[
    'TransitGatewayPeering' => [
        'Peering' => [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'PeeringId' => '<string>',
            'PeeringType' => 'TRANSIT_GATEWAY',
            'ResourceArn' => '<string>',
            'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'TransitGatewayArn' => '<string>',
        'TransitGatewayPeeringAttachmentId' => '<string>',
    ],
]

Result Details

Members
TransitGatewayPeering
  • Type: TransitGatewayPeering structure

Returns information about the transit gateway peering connection request.

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.

CreateTransitGatewayRouteTableAttachment

$result = $client->createTransitGatewayRouteTableAttachment([/* ... */]);
$promise = $client->createTransitGatewayRouteTableAttachmentAsync([/* ... */]);

Creates a transit gateway route table attachment.

Parameter Syntax

$result = $client->createTransitGatewayRouteTableAttachment([
    'ClientToken' => '<string>',
    'PeeringId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TransitGatewayRouteTableArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

PeeringId
  • Required: Yes
  • Type: string

The ID of the peer for the

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the request.

TransitGatewayRouteTableArn
  • Required: Yes
  • Type: string

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

Result Syntax

[
    'TransitGatewayRouteTableAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'PeeringId' => '<string>',
        'TransitGatewayRouteTableArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayRouteTableAttachment
  • Type: TransitGatewayRouteTableAttachment structure

The route table associated with the create transit gateway route table attachment request.

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.

CreateVpcAttachment

$result = $client->createVpcAttachment([/* ... */]);
$promise = $client->createVpcAttachmentAsync([/* ... */]);

Creates a VPC attachment on an edge location of a core network.

Parameter Syntax

$result = $client->createVpcAttachment([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'Options' => [
        'ApplianceModeSupport' => true || false,
        'Ipv6Support' => true || false,
    ],
    'SubnetArns' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network for the VPC attachment.

Options
  • Type: VpcOptions structure

Options for the VPC attachment.

SubnetArns
  • Required: Yes
  • Type: Array of strings

The subnet ARN of the VPC attachment.

Tags
  • Type: Array of Tag structures

The key-value tags associated with the request.

VpcArn
  • Required: Yes
  • Type: string

The ARN of the VPC.

Result Syntax

[
    'VpcAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'Options' => [
            'ApplianceModeSupport' => true || false,
            'Ipv6Support' => true || false,
        ],
        'SubnetArns' => ['<string>', ...],
    ],
]

Result Details

Members
VpcAttachment
  • Type: VpcAttachment structure

Provides details about the VPC attachment.

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.

DeleteAttachment

$result = $client->deleteAttachment([/* ... */]);
$promise = $client->deleteAttachmentAsync([/* ... */]);

Deletes an attachment. Supports all attachment types.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment to delete.

Result Syntax

[
    'Attachment' => [
        'AttachmentId' => '<string>',
        'AttachmentPolicyRuleNumber' => <integer>,
        'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProposedSegmentChange' => [
            'AttachmentPolicyRuleNumber' => <integer>,
            'SegmentName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'ResourceArn' => '<string>',
        'SegmentName' => '<string>',
        'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Members
Attachment
  • Type: Attachment structure

Information about the deleted attachment.

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.

DeleteConnectPeer

$result = $client->deleteConnectPeer([/* ... */]);
$promise = $client->deleteConnectPeerAsync([/* ... */]);

Deletes a Connect peer.

Parameter Syntax

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

Parameter Details

Members
ConnectPeerId
  • Required: Yes
  • Type: string

The ID of the deleted Connect peer.

Result Syntax

[
    'ConnectPeer' => [
        'Configuration' => [
            'BgpConfigurations' => [
                [
                    'CoreNetworkAddress' => '<string>',
                    'CoreNetworkAsn' => <integer>,
                    'PeerAddress' => '<string>',
                    'PeerAsn' => <integer>,
                ],
                // ...
            ],
            'CoreNetworkAddress' => '<string>',
            'InsideCidrBlocks' => ['<string>', ...],
            'PeerAddress' => '<string>',
            'Protocol' => 'GRE',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ConnectPeer
  • Type: ConnectPeer structure

Information about the deleted Connect peer.

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.

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.

DeleteCoreNetwork

$result = $client->deleteCoreNetwork([/* ... */]);
$promise = $client->deleteCoreNetworkAsync([/* ... */]);

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The network ID of the deleted core network.

Result Syntax

[
    'CoreNetwork' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Edges' => [
            [
                'Asn' => <integer>,
                'EdgeLocation' => '<string>',
                'InsideCidrBlocks' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalNetworkId' => '<string>',
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
CoreNetwork
  • Type: CoreNetwork structure

Information about the deleted core 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.

DeleteCoreNetworkPolicyVersion

$result = $client->deleteCoreNetworkPolicyVersion([/* ... */]);
$promise = $client->deleteCoreNetworkPolicyVersionAsync([/* ... */]);

Deletes a policy version from a core network. You can't delete the current LIVE policy.

Parameter Syntax

$result = $client->deleteCoreNetworkPolicyVersion([
    'CoreNetworkId' => '<string>', // REQUIRED
    'PolicyVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network for the deleted policy.

PolicyVersionId
  • Required: Yes
  • Type: int

The version ID of the deleted policy.

Result Syntax

[
    'CoreNetworkPolicy' => [
        'Alias' => 'LIVE|LATEST',
        'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'PolicyDocument' => '<string>',
        'PolicyErrors' => [
            [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
                'Path' => '<string>',
            ],
            // ...
        ],
        'PolicyVersionId' => <integer>,
    ],
]

Result Details

Members
CoreNetworkPolicy
  • Type: CoreNetworkPolicy structure

Returns information about the deleted policy version.

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.

  • ConflictException:

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

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), deregister all transit gateways, and delete any core networks.

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.

DeletePeering

$result = $client->deletePeering([/* ... */]);
$promise = $client->deletePeeringAsync([/* ... */]);

Deletes an existing peering connection.

Parameter Syntax

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

Parameter Details

Members
PeeringId
  • Required: Yes
  • Type: string

The ID of the peering connection to delete.

Result Syntax

[
    'Peering' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'OwnerAccountId' => '<string>',
        'PeeringId' => '<string>',
        'PeeringType' => 'TRANSIT_GATEWAY',
        'ResourceArn' => '<string>',
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
Peering
  • Type: Peering structure

Information about a deleted peering 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.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The ARN of the policy to delete.

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.

  • 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.

DisassociateConnectPeer

$result = $client->disassociateConnectPeer([/* ... */]);
$promise = $client->disassociateConnectPeerAsync([/* ... */]);

Disassociates a core network Connect peer from a device and a link.

Parameter Syntax

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

Parameter Details

Members
ConnectPeerId
  • Required: Yes
  • Type: string

The ID of the Connect peer to disassociate from a device.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Result Syntax

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

Result Details

Members
ConnectPeerAssociation
  • Type: ConnectPeerAssociation structure

Describes the 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.

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.

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.

ExecuteCoreNetworkChangeSet

$result = $client->executeCoreNetworkChangeSet([/* ... */]);
$promise = $client->executeCoreNetworkChangeSetAsync([/* ... */]);

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

Parameter Syntax

$result = $client->executeCoreNetworkChangeSet([
    'CoreNetworkId' => '<string>', // REQUIRED
    'PolicyVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

PolicyVersionId
  • Required: Yes
  • Type: int

The ID of the policy version.

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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

  • ConflictException:

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

GetConnectAttachment

$result = $client->getConnectAttachment([/* ... */]);
$promise = $client->getConnectAttachmentAsync([/* ... */]);

Returns information about a core network Connect attachment.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Result Syntax

[
    'ConnectAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'Options' => [
            'Protocol' => 'GRE',
        ],
        'TransportAttachmentId' => '<string>',
    ],
]

Result Details

Members
ConnectAttachment
  • Type: ConnectAttachment structure

Details about the Connect attachment.

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.

GetConnectPeer

$result = $client->getConnectPeer([/* ... */]);
$promise = $client->getConnectPeerAsync([/* ... */]);

Returns information about a core network Connect peer.

Parameter Syntax

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

Parameter Details

Members
ConnectPeerId
  • Required: Yes
  • Type: string

The ID of the Connect peer.

Result Syntax

[
    'ConnectPeer' => [
        'Configuration' => [
            'BgpConfigurations' => [
                [
                    'CoreNetworkAddress' => '<string>',
                    'CoreNetworkAsn' => <integer>,
                    'PeerAddress' => '<string>',
                    'PeerAsn' => <integer>,
                ],
                // ...
            ],
            'CoreNetworkAddress' => '<string>',
            'InsideCidrBlocks' => ['<string>', ...],
            'PeerAddress' => '<string>',
            'Protocol' => 'GRE',
        ],
        'ConnectAttachmentId' => '<string>',
        'ConnectPeerId' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
ConnectPeer
  • Type: ConnectPeer structure

Returns information about a core network Connect peer.

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.

GetConnectPeerAssociations

$result = $client->getConnectPeerAssociations([/* ... */]);
$promise = $client->getConnectPeerAssociationsAsync([/* ... */]);

Returns information about a core network Connect peer associations.

Parameter Syntax

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

Parameter Details

Members
ConnectPeerIds
  • Type: Array of strings

The IDs of the Connect peers.

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

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

Result Details

Members
ConnectPeerAssociations
  • Type: Array of ConnectPeerAssociation structures

Displays a list of Connect peer 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.

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.

GetCoreNetwork

$result = $client->getCoreNetwork([/* ... */]);
$promise = $client->getCoreNetworkAsync([/* ... */]);

Returns information about the LIVE policy for a core network.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

Result Syntax

[
    'CoreNetwork' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Edges' => [
            [
                'Asn' => <integer>,
                'EdgeLocation' => '<string>',
                'InsideCidrBlocks' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalNetworkId' => '<string>',
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
CoreNetwork
  • Type: CoreNetwork structure

Details about a core 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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetCoreNetworkChangeEvents

$result = $client->getCoreNetworkChangeEvents([/* ... */]);
$promise = $client->getCoreNetworkChangeEventsAsync([/* ... */]);

Returns information about a core network change event.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

PolicyVersionId
  • Required: Yes
  • Type: int

The ID of the policy version.

Result Syntax

[
    'CoreNetworkChangeEvents' => [
        [
            'Action' => 'ADD|MODIFY|REMOVE',
            'EventTime' => <DateTime>,
            'IdentifierPath' => '<string>',
            'Status' => 'NOT_STARTED|IN_PROGRESS|COMPLETE|FAILED',
            'Type' => 'CORE_NETWORK_SEGMENT|CORE_NETWORK_EDGE|ATTACHMENT_MAPPING|ATTACHMENT_ROUTE_PROPAGATION|ATTACHMENT_ROUTE_STATIC|CORE_NETWORK_CONFIGURATION|SEGMENTS_CONFIGURATION|SEGMENT_ACTIONS_CONFIGURATION|ATTACHMENT_POLICIES_CONFIGURATION',
            'Values' => [
                'AttachmentId' => '<string>',
                'Cidr' => '<string>',
                'EdgeLocation' => '<string>',
                'SegmentName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CoreNetworkChangeEvents
  • Type: Array of CoreNetworkChangeEvent structures

The response to GetCoreNetworkChangeEventsRequest.

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.

GetCoreNetworkChangeSet

$result = $client->getCoreNetworkChangeSet([/* ... */]);
$promise = $client->getCoreNetworkChangeSetAsync([/* ... */]);

Returns a change set between the LIVE core network policy and a submitted policy.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

PolicyVersionId
  • Required: Yes
  • Type: int

The ID of the policy version.

Result Syntax

[
    'CoreNetworkChanges' => [
        [
            'Action' => 'ADD|MODIFY|REMOVE',
            'Identifier' => '<string>',
            'IdentifierPath' => '<string>',
            'NewValues' => [
                'Asn' => <integer>,
                'Cidr' => '<string>',
                'DestinationIdentifier' => '<string>',
                'EdgeLocations' => ['<string>', ...],
                'InsideCidrBlocks' => ['<string>', ...],
                'SegmentName' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            'PreviousValues' => [
                'Asn' => <integer>,
                'Cidr' => '<string>',
                'DestinationIdentifier' => '<string>',
                'EdgeLocations' => ['<string>', ...],
                'InsideCidrBlocks' => ['<string>', ...],
                'SegmentName' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            'Type' => 'CORE_NETWORK_SEGMENT|CORE_NETWORK_EDGE|ATTACHMENT_MAPPING|ATTACHMENT_ROUTE_PROPAGATION|ATTACHMENT_ROUTE_STATIC|CORE_NETWORK_CONFIGURATION|SEGMENTS_CONFIGURATION|SEGMENT_ACTIONS_CONFIGURATION|ATTACHMENT_POLICIES_CONFIGURATION',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CoreNetworkChanges
  • Type: Array of CoreNetworkChange structures

Describes a core network changes.

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.

GetCoreNetworkPolicy

$result = $client->getCoreNetworkPolicy([/* ... */]);
$promise = $client->getCoreNetworkPolicyAsync([/* ... */]);

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

Parameter Syntax

$result = $client->getCoreNetworkPolicy([
    'Alias' => 'LIVE|LATEST',
    'CoreNetworkId' => '<string>', // REQUIRED
    'PolicyVersionId' => <integer>,
]);

Parameter Details

Members
Alias
  • Type: string

The alias of a core network policy

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

PolicyVersionId
  • Type: int

The ID of a core network policy version.

Result Syntax

[
    'CoreNetworkPolicy' => [
        'Alias' => 'LIVE|LATEST',
        'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'PolicyDocument' => '<string>',
        'PolicyErrors' => [
            [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
                'Path' => '<string>',
            ],
            // ...
        ],
        'PolicyVersionId' => <integer>,
    ],
]

Result Details

Members
CoreNetworkPolicy
  • Type: CoreNetworkPolicy structure

The details about a core network policy.

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). 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.

GetNetworkResourceCounts

$result = $client->getNetworkResourceCounts([/* ... */]);
$promise = $client->getNetworkResourceCountsAsync([/* ... */]);

Gets the count of network resources, by resource type, for the specified global network.

Parameter Syntax

$result = $client->getNetworkResourceCounts([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceType' => '<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.

ResourceType
  • Type: string

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon

  • dx-gateway

  • dx-vif

The following are the supported resource types for Network Manager:

  • connection

  • device

  • link

  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway

  • transit-gateway

  • transit-gateway-attachment

  • transit-gateway-connect-peer

  • transit-gateway-route-table

  • vpn-connection

Result Syntax

[
    'NetworkResourceCounts' => [
        [
            'Count' => <integer>,
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
NetworkResourceCounts
  • Type: Array of NetworkResourceCount structures

The count of resources.

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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetNetworkResourceRelationships

$result = $client->getNetworkResourceRelationships([/* ... */]);
$promise = $client->getNetworkResourceRelationshipsAsync([/* ... */]);

Gets the network resource relationships for the specified global network.

Parameter Syntax

$result = $client->getNetworkResourceRelationships([
    'AccountId' => '<string>',
    'AwsRegion' => '<string>',
    'CoreNetworkId' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegisteredGatewayArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceType' => '<string>',
]);

Parameter Details

Members
AccountId
  • Type: string

The Amazon Web Services account ID.

AwsRegion
  • Type: string

The Amazon Web Services Region.

CoreNetworkId
  • Type: string

The ID of a core network.

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.

RegisteredGatewayArn
  • Type: string

The ARN of the registered gateway.

ResourceArn
  • Type: string

The ARN of the gateway.

ResourceType
  • Type: string

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon

  • dx-gateway

  • dx-vif

The following are the supported resource types for Network Manager:

  • connection

  • device

  • link

  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway

  • transit-gateway

  • transit-gateway-attachment

  • transit-gateway-connect-peer

  • transit-gateway-route-table

  • vpn-connection

Result Syntax

[
    'NextToken' => '<string>',
    'Relationships' => [
        [
            'From' => '<string>',
            'To' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token for the next page of results.

Relationships
  • Type: Array of Relationship structures

The resource relationships.

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.

GetNetworkResources

$result = $client->getNetworkResources([/* ... */]);
$promise = $client->getNetworkResourcesAsync([/* ... */]);

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

Parameter Syntax

$result = $client->getNetworkResources([
    'AccountId' => '<string>',
    'AwsRegion' => '<string>',
    'CoreNetworkId' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegisteredGatewayArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceType' => '<string>',
]);

Parameter Details

Members
AccountId
  • Type: string

The Amazon Web Services account ID.

AwsRegion
  • Type: string

The Amazon Web Services Region.

CoreNetworkId
  • Type: string

The ID of a core network.

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.

RegisteredGatewayArn
  • Type: string

The ARN of the gateway.

ResourceArn
  • Type: string

The ARN of the resource.

ResourceType
  • Type: string

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon - The definition model is Connection.

  • dx-gateway - The definition model is DirectConnectGateway.

  • dx-vif - The definition model is VirtualInterface.

The following are the supported resource types for Network Manager:

  • connection - The definition model is Connection.

  • device - The definition model is Device.

  • link - The definition model is Link.

  • site - The definition model is Site.

The following are the supported resource types for Amazon VPC:

  • customer-gateway - The definition model is CustomerGateway.

  • transit-gateway - The definition model is TransitGateway.

  • transit-gateway-attachment - The definition model is TransitGatewayAttachment.

  • transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.

  • transit-gateway-route-table - The definition model is TransitGatewayRouteTable.

  • vpn-connection - The definition model is VpnConnection.

Result Syntax

[
    'NetworkResources' => [
        [
            'AccountId' => '<string>',
            'AwsRegion' => '<string>',
            'CoreNetworkId' => '<string>',
            'Definition' => '<string>',
            'DefinitionTimestamp' => <DateTime>,
            'Metadata' => ['<string>', ...],
            'RegisteredGatewayArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
NetworkResources
  • Type: Array of NetworkResource structures

The network resources.

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.

GetNetworkRoutes

$result = $client->getNetworkRoutes([/* ... */]);
$promise = $client->getNetworkRoutesAsync([/* ... */]);

Gets the network routes of the specified global network.

Parameter Syntax

$result = $client->getNetworkRoutes([
    'DestinationFilters' => [
        '<FilterName>' => ['<string>', ...],
        // ...
    ],
    'ExactCidrMatches' => ['<string>', ...],
    'GlobalNetworkId' => '<string>', // REQUIRED
    'LongestPrefixMatches' => ['<string>', ...],
    'PrefixListIds' => ['<string>', ...],
    'RouteTableIdentifier' => [ // REQUIRED
        'CoreNetworkSegmentEdge' => [
            'CoreNetworkId' => '<string>',
            'EdgeLocation' => '<string>',
            'SegmentName' => '<string>',
        ],
        'TransitGatewayRouteTableArn' => '<string>',
    ],
    'States' => ['<string>', ...],
    'SubnetOfMatches' => ['<string>', ...],
    'SupernetOfMatches' => ['<string>', ...],
    'Types' => ['<string>', ...],
]);

Parameter Details

Members
DestinationFilters
  • Type: Associative array of custom strings keys (FilterName) to stringss

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

ExactCidrMatches
  • Type: Array of strings

An exact CIDR block.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

LongestPrefixMatches
  • Type: Array of strings

The most specific route that matches the traffic (longest prefix match).

PrefixListIds
  • Type: Array of strings

The IDs of the prefix lists.

RouteTableIdentifier
  • Required: Yes
  • Type: RouteTableIdentifier structure

The ID of the route table.

States
  • Type: Array of strings

The route states.

SubnetOfMatches
  • Type: Array of strings

The routes with a subnet that match the specified CIDR filter.

SupernetOfMatches
  • Type: Array of strings

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

Types
  • Type: Array of strings

The route types.

Result Syntax

[
    'CoreNetworkSegmentEdge' => [
        'CoreNetworkId' => '<string>',
        'EdgeLocation' => '<string>',
        'SegmentName' => '<string>',
    ],
    'NetworkRoutes' => [
        [
            'DestinationCidrBlock' => '<string>',
            'Destinations' => [
                [
                    'CoreNetworkAttachmentId' => '<string>',
                    'EdgeLocation' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                    'SegmentName' => '<string>',
                    'TransitGatewayAttachmentId' => '<string>',
                ],
                // ...
            ],
            'PrefixListId' => '<string>',
            'State' => 'ACTIVE|BLACKHOLE',
            'Type' => 'PROPAGATED|STATIC',
        ],
        // ...
    ],
    'RouteTableArn' => '<string>',
    'RouteTableTimestamp' => <DateTime>,
    'RouteTableType' => 'TRANSIT_GATEWAY_ROUTE_TABLE|CORE_NETWORK_SEGMENT',
]

Result Details

Members
CoreNetworkSegmentEdge
  • Type: CoreNetworkSegmentEdgeIdentifier structure

Describes a core network segment edge.

NetworkRoutes
  • Type: Array of NetworkRoute structures

The network routes.

RouteTableArn
  • Type: string

The ARN of the route table.

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

The route table creation time.

RouteTableType
  • Type: string

The route table type.

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.

GetNetworkTelemetry

$result = $client->getNetworkTelemetry([/* ... */]);
$promise = $client->getNetworkTelemetryAsync([/* ... */]);

Gets the network telemetry of the specified global network.

Parameter Syntax

$result = $client->getNetworkTelemetry([
    'AccountId' => '<string>',
    'AwsRegion' => '<string>',
    'CoreNetworkId' => '<string>',
    'GlobalNetworkId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RegisteredGatewayArn' => '<string>',
    'ResourceArn' => '<string>',
    'ResourceType' => '<string>',
]);

Parameter Details

Members
AccountId
  • Type: string

The Amazon Web Services account ID.

AwsRegion
  • Type: string

The Amazon Web Services Region.

CoreNetworkId
  • Type: string

The ID of a core network.

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.

RegisteredGatewayArn
  • Type: string

The ARN of the gateway.

ResourceArn
  • Type: string

The ARN of the resource.

ResourceType
  • Type: string

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon

  • dx-gateway

  • dx-vif

The following are the supported resource types for Network Manager:

  • connection

  • device

  • link

  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway

  • transit-gateway

  • transit-gateway-attachment

  • transit-gateway-connect-peer

  • transit-gateway-route-table

  • vpn-connection

Result Syntax

[
    'NetworkTelemetry' => [
        [
            'AccountId' => '<string>',
            'Address' => '<string>',
            'AwsRegion' => '<string>',
            'CoreNetworkId' => '<string>',
            'Health' => [
                'Status' => 'UP|DOWN',
                'Timestamp' => <DateTime>,
                'Type' => 'BGP|IPSEC',
            ],
            'RegisteredGatewayArn' => '<string>',
            'ResourceArn' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
NetworkTelemetry
  • Type: Array of NetworkTelemetry structures

The network telemetry.

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.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Returns information about a resource policy.

Parameter Syntax

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

Parameter Details

Members
ResourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

Result Syntax

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

Result Details

Members
PolicyDocument
  • Type: string (string|number|array|map or anything parsable by json_encode)

The resource policy document.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

GetRouteAnalysis

$result = $client->getRouteAnalysis([/* ... */]);
$promise = $client->getRouteAnalysisAsync([/* ... */]);

Gets information about the specified route analysis.

Parameter Syntax

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

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

RouteAnalysisId
  • Required: Yes
  • Type: string

The ID of the route analysis.

Result Syntax

[
    'RouteAnalysis' => [
        'Destination' => [
            'IpAddress' => '<string>',
            'TransitGatewayArn' => '<string>',
            'TransitGatewayAttachmentArn' => '<string>',
        ],
        'ForwardPath' => [
            'CompletionStatus' => [
                'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext' => ['<string>', ...],
                'ResultCode' => 'CONNECTED|NOT_CONNECTED',
            ],
            'Path' => [
                [
                    'DestinationCidrBlock' => '<string>',
                    'Resource' => [
                        'Definition' => '<string>',
                        'IsMiddlebox' => true || false,
                        'NameTag' => '<string>',
                        'RegisteredGatewayArn' => '<string>',
                        'ResourceArn' => '<string>',
                        'ResourceType' => '<string>',
                    ],
                    'Sequence' => <integer>,
                ],
                // ...
            ],
        ],
        'GlobalNetworkId' => '<string>',
        'IncludeReturnPath' => true || false,
        'OwnerAccountId' => '<string>',
        'ReturnPath' => [
            'CompletionStatus' => [
                'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext' => ['<string>', ...],
                'ResultCode' => 'CONNECTED|NOT_CONNECTED',
            ],
            'Path' => [
                [
                    'DestinationCidrBlock' => '<string>',
                    'Resource' => [
                        'Definition' => '<string>',
                        'IsMiddlebox' => true || false,
                        'NameTag' => '<string>',
                        'RegisteredGatewayArn' => '<string>',
                        'ResourceArn' => '<string>',
                        'ResourceType' => '<string>',
                    ],
                    'Sequence' => <integer>,
                ],
                // ...
            ],
        ],
        'RouteAnalysisId' => '<string>',
        'Source' => [
            'IpAddress' => '<string>',
            'TransitGatewayArn' => '<string>',
            'TransitGatewayAttachmentArn' => '<string>',
        ],
        'StartTimestamp' => <DateTime>,
        'Status' => 'RUNNING|COMPLETED|FAILED',
        'UseMiddleboxes' => true || false,
    ],
]

Result Details

Members
RouteAnalysis
  • Type: RouteAnalysis structure

The route analysis.

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.

GetSiteToSiteVpnAttachment

$result = $client->getSiteToSiteVpnAttachment([/* ... */]);
$promise = $client->getSiteToSiteVpnAttachmentAsync([/* ... */]);

Returns information about a site-to-site VPN attachment.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Result Syntax

[
    'SiteToSiteVpnAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'VpnConnectionArn' => '<string>',
    ],
]

Result Details

Members
SiteToSiteVpnAttachment
  • Type: SiteToSiteVpnAttachment structure

Describes the site-to-site attachment.

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.

GetTransitGatewayPeering

$result = $client->getTransitGatewayPeering([/* ... */]);
$promise = $client->getTransitGatewayPeeringAsync([/* ... */]);

Returns information about a transit gateway peer.

Parameter Syntax

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

Parameter Details

Members
PeeringId
  • Required: Yes
  • Type: string

The ID of the peering request.

Result Syntax

[
    'TransitGatewayPeering' => [
        'Peering' => [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'PeeringId' => '<string>',
            'PeeringType' => 'TRANSIT_GATEWAY',
            'ResourceArn' => '<string>',
            'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'TransitGatewayArn' => '<string>',
        'TransitGatewayPeeringAttachmentId' => '<string>',
    ],
]

Result Details

Members
TransitGatewayPeering
  • Type: TransitGatewayPeering structure

Returns information about a transit gateway peering.

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.

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.

GetTransitGatewayRouteTableAttachment

$result = $client->getTransitGatewayRouteTableAttachment([/* ... */]);
$promise = $client->getTransitGatewayRouteTableAttachmentAsync([/* ... */]);

Returns information about a transit gateway route table attachment.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the transit gateway route table attachment.

Result Syntax

[
    'TransitGatewayRouteTableAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'PeeringId' => '<string>',
        'TransitGatewayRouteTableArn' => '<string>',
    ],
]

Result Details

Members
TransitGatewayRouteTableAttachment
  • Type: TransitGatewayRouteTableAttachment structure

Returns information about the transit gateway route table attachment.

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.

GetVpcAttachment

$result = $client->getVpcAttachment([/* ... */]);
$promise = $client->getVpcAttachmentAsync([/* ... */]);

Returns information about a VPC attachment.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Result Syntax

[
    'VpcAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'Options' => [
            'ApplianceModeSupport' => true || false,
            'Ipv6Support' => true || false,
        ],
        'SubnetArns' => ['<string>', ...],
    ],
]

Result Details

Members
VpcAttachment
  • Type: VpcAttachment structure

Returns details about a VPC attachment.

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.

ListAttachments

$result = $client->listAttachments([/* ... */]);
$promise = $client->listAttachmentsAsync([/* ... */]);

Returns a list of core network attachments.

Parameter Syntax

$result = $client->listAttachments([
    'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
    'CoreNetworkId' => '<string>',
    'EdgeLocation' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
]);

Parameter Details

Members
AttachmentType
  • Type: string

The type of attachment.

CoreNetworkId
  • Type: string

The ID of a core network.

EdgeLocation
  • Type: string

The Region where the edge is located.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

State
  • Type: string

The state of the attachment.

Result Syntax

[
    'Attachments' => [
        [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Attachments
  • Type: Array of Attachment structures

Describes the list of attachments.

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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

ListConnectPeers

$result = $client->listConnectPeers([/* ... */]);
$promise = $client->listConnectPeersAsync([/* ... */]);

Returns a list of core network Connect peers.

Parameter Syntax

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

Parameter Details

Members
ConnectAttachmentId
  • Type: string

The ID of the attachment.

CoreNetworkId
  • Type: string

The ID of a core network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'ConnectPeers' => [
        [
            'ConnectAttachmentId' => '<string>',
            'ConnectPeerId' => '<string>',
            'ConnectPeerState' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
ConnectPeers
  • Type: Array of ConnectPeerSummary structures

Describes the Connect peers.

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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

ListCoreNetworkPolicyVersions

$result = $client->listCoreNetworkPolicyVersions([/* ... */]);
$promise = $client->listCoreNetworkPolicyVersionsAsync([/* ... */]);

Returns a list of core network policy versions.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'CoreNetworkPolicyVersions' => [
        [
            'Alias' => 'LIVE|LATEST',
            'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'PolicyVersionId' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CoreNetworkPolicyVersions
  • Type: Array of CoreNetworkPolicyVersion structures

Describes core network policy versions.

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.

ListCoreNetworks

$result = $client->listCoreNetworks([/* ... */]);
$promise = $client->listCoreNetworksAsync([/* ... */]);

Returns a list of owned and shared core networks.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'CoreNetworks' => [
        [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'Description' => '<string>',
            'GlobalNetworkId' => '<string>',
            'OwnerAccountId' => '<string>',
            'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
CoreNetworks
  • Type: Array of CoreNetworkSummary structures

Describes the list of core 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.

  • ThrottlingException:

    The request was denied due to request throttling.

  • InternalServerException:

    The request has failed due to an internal error.

ListOrganizationServiceAccessStatus

$result = $client->listOrganizationServiceAccessStatus([/* ... */]);
$promise = $client->listOrganizationServiceAccessStatusAsync([/* ... */]);

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

Parameter Syntax

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

Parameter Details

Members
MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'OrganizationStatus' => [
        'AccountStatusList' => [
            [
                'AccountId' => '<string>',
                'SLRDeploymentStatus' => '<string>',
            ],
            // ...
        ],
        'OrganizationAwsServiceAccessStatus' => '<string>',
        'OrganizationId' => '<string>',
        'SLRDeploymentStatus' => '<string>',
    ],
]

Result Details

Members
NextToken
  • Type: string

The token for the next page of results.

OrganizationStatus
  • Type: OrganizationStatus structure

Displays the status of an Amazon Web Services Organization.

Errors

There are no errors described for this operation.

ListPeerings

$result = $client->listPeerings([/* ... */]);
$promise = $client->listPeeringsAsync([/* ... */]);

Lists the peerings for a core network.

Parameter Syntax

$result = $client->listPeerings([
    'CoreNetworkId' => '<string>',
    'EdgeLocation' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PeeringType' => 'TRANSIT_GATEWAY',
    'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
]);

Parameter Details

Members
CoreNetworkId
  • Type: string

The ID of a core network.

EdgeLocation
  • Type: string

Returns a list edge locations for the

MaxResults
  • Type: int

The maximum number of results to return.

NextToken
  • Type: string

The token for the next page of results.

PeeringType
  • Type: string

Returns a list of a peering requests.

State
  • Type: string

Returns a list of the peering request states.

Result Syntax

[
    'NextToken' => '<string>',
    'Peerings' => [
        [
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'PeeringId' => '<string>',
            'PeeringType' => 'TRANSIT_GATEWAY',
            'ResourceArn' => '<string>',
            'State' => 'CREATING|FAILED|AVAILABLE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
  • Type: string

The token for the next page of results.

Peerings
  • Type: Array of Peering structures

Lists the transit gateway peerings for the ListPeerings request.

Errors

  • ValidationException:

    The input fails to satisfy the constraints.

  • AccessDeniedException:

    You do not have sufficient access to perform this action.

  • 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.

PutCoreNetworkPolicy

$result = $client->putCoreNetworkPolicy([/* ... */]);
$promise = $client->putCoreNetworkPolicyAsync([/* ... */]);

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

Parameter Syntax

$result = $client->putCoreNetworkPolicy([
    'ClientToken' => '<string>',
    'CoreNetworkId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'LatestVersionId' => <integer>,
    'PolicyDocument' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientToken
  • Type: string

The client token associated with the request.

CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

Description
  • Type: string

a core network policy description.

LatestVersionId
  • Type: int

The ID of a core network policy.

PolicyDocument
  • Required: Yes
  • Type: string (string|number|array|map or anything parsable by json_encode)

The policy document.

Result Syntax

[
    'CoreNetworkPolicy' => [
        'Alias' => 'LIVE|LATEST',
        'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'PolicyDocument' => '<string>',
        'PolicyErrors' => [
            [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
                'Path' => '<string>',
            ],
            // ...
        ],
        'PolicyVersionId' => <integer>,
    ],
]

Result Details

Members
CoreNetworkPolicy
  • Type: CoreNetworkPolicy structure

Describes the changed core network policy.

Errors

  • CoreNetworkPolicyException:

    Describes a core network policy exception.

  • 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.

  • ConflictException:

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

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Creates or updates a resource policy.

Parameter Syntax

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

Parameter Details

Members
PolicyDocument
  • Required: Yes
  • Type: string (string|number|array|map or anything parsable by json_encode)

The JSON resource policy document.

ResourceArn
  • Required: Yes
  • Type: string

The ARN of the resource policy.

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.

  • 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.

RegisterTransitGateway

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

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services 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.

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.

RejectAttachment

$result = $client->rejectAttachment([/* ... */]);
$promise = $client->rejectAttachmentAsync([/* ... */]);

Rejects a core network attachment request.

Parameter Syntax

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

Parameter Details

Members
AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Result Syntax

[
    'Attachment' => [
        'AttachmentId' => '<string>',
        'AttachmentPolicyRuleNumber' => <integer>,
        'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'EdgeLocation' => '<string>',
        'OwnerAccountId' => '<string>',
        'ProposedSegmentChange' => [
            'AttachmentPolicyRuleNumber' => <integer>,
            'SegmentName' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'ResourceArn' => '<string>',
        'SegmentName' => '<string>',
        'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Members
Attachment
  • Type: Attachment structure

Describes the rejected attachment request.

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.

RestoreCoreNetworkPolicyVersion

$result = $client->restoreCoreNetworkPolicyVersion([/* ... */]);
$promise = $client->restoreCoreNetworkPolicyVersionAsync([/* ... */]);

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

Parameter Syntax

$result = $client->restoreCoreNetworkPolicyVersion([
    'CoreNetworkId' => '<string>', // REQUIRED
    'PolicyVersionId' => <integer>, // REQUIRED
]);

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

PolicyVersionId
  • Required: Yes
  • Type: int

The ID of the policy version to restore.

Result Syntax

[
    'CoreNetworkPolicy' => [
        'Alias' => 'LIVE|LATEST',
        'ChangeSetState' => 'PENDING_GENERATION|FAILED_GENERATION|READY_TO_EXECUTE|EXECUTING|EXECUTION_SUCCEEDED|OUT_OF_DATE',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'PolicyDocument' => '<string>',
        'PolicyErrors' => [
            [
                'ErrorCode' => '<string>',
                'Message' => '<string>',
                'Path' => '<string>',
            ],
            // ...
        ],
        'PolicyVersionId' => <integer>,
    ],
]

Result Details

Members
CoreNetworkPolicy
  • Type: CoreNetworkPolicy structure

Describes the restored core network policy.

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.

  • ConflictException:

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

StartOrganizationServiceAccessUpdate

$result = $client->startOrganizationServiceAccessUpdate([/* ... */]);
$promise = $client->startOrganizationServiceAccessUpdateAsync([/* ... */]);

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

Parameter Syntax

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

Parameter Details

Members
Action
  • Required: Yes
  • Type: string

The action to take for the update request. This can be either ENABLE or DISABLE.

Result Syntax

[
    'OrganizationStatus' => [
        'AccountStatusList' => [
            [
                'AccountId' => '<string>',
                'SLRDeploymentStatus' => '<string>',
            ],
            // ...
        ],
        'OrganizationAwsServiceAccessStatus' => '<string>',
        'OrganizationId' => '<string>',
        'SLRDeploymentStatus' => '<string>',
    ],
]

Result Details

Members
OrganizationStatus
  • Type: OrganizationStatus structure

The status of the service access update request for an Amazon Web Services Organization.

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.

StartRouteAnalysis

$result = $client->startRouteAnalysis([/* ... */]);
$promise = $client->startRouteAnalysisAsync([/* ... */]);

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

Parameter Syntax

$result = $client->startRouteAnalysis([
    'Destination' => [ // REQUIRED
        'IpAddress' => '<string>',
        'TransitGatewayAttachmentArn' => '<string>',
    ],
    'GlobalNetworkId' => '<string>', // REQUIRED
    'IncludeReturnPath' => true || false,
    'Source' => [ // REQUIRED
        'IpAddress' => '<string>',
        'TransitGatewayAttachmentArn' => '<string>',
    ],
    'UseMiddleboxes' => true || false,
]);

Parameter Details

Members
Destination
  • Required: Yes
  • Type: RouteAnalysisEndpointOptionsSpecification structure

The destination.

GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

IncludeReturnPath
  • Type: boolean

Indicates whether to analyze the return path. The default is false.

Source
  • Required: Yes
  • Type: RouteAnalysisEndpointOptionsSpecification structure

The source from which traffic originates.

UseMiddleboxes
  • Type: boolean

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

Result Syntax

[
    'RouteAnalysis' => [
        'Destination' => [
            'IpAddress' => '<string>',
            'TransitGatewayArn' => '<string>',
            'TransitGatewayAttachmentArn' => '<string>',
        ],
        'ForwardPath' => [
            'CompletionStatus' => [
                'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext' => ['<string>', ...],
                'ResultCode' => 'CONNECTED|NOT_CONNECTED',
            ],
            'Path' => [
                [
                    'DestinationCidrBlock' => '<string>',
                    'Resource' => [
                        'Definition' => '<string>',
                        'IsMiddlebox' => true || false,
                        'NameTag' => '<string>',
                        'RegisteredGatewayArn' => '<string>',
                        'ResourceArn' => '<string>',
                        'ResourceType' => '<string>',
                    ],
                    'Sequence' => <integer>,
                ],
                // ...
            ],
        ],
        'GlobalNetworkId' => '<string>',
        'IncludeReturnPath' => true || false,
        'OwnerAccountId' => '<string>',
        'ReturnPath' => [
            'CompletionStatus' => [
                'ReasonCode' => 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND|TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY|CYCLIC_PATH_DETECTED|TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND|ROUTE_NOT_FOUND|BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND|INACTIVE_ROUTE_FOR_DESTINATION_FOUND|TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH|MAX_HOPS_EXCEEDED|POSSIBLE_MIDDLEBOX|NO_DESTINATION_ARN_PROVIDED',
                'ReasonContext' => ['<string>', ...],
                'ResultCode' => 'CONNECTED|NOT_CONNECTED',
            ],
            'Path' => [
                [
                    'DestinationCidrBlock' => '<string>',
                    'Resource' => [
                        'Definition' => '<string>',
                        'IsMiddlebox' => true || false,
                        'NameTag' => '<string>',
                        'RegisteredGatewayArn' => '<string>',
                        'ResourceArn' => '<string>',
                        'ResourceType' => '<string>',
                    ],
                    'Sequence' => <integer>,
                ],
                // ...
            ],
        ],
        'RouteAnalysisId' => '<string>',
        'Source' => [
            'IpAddress' => '<string>',
            'TransitGatewayArn' => '<string>',
            'TransitGatewayAttachmentArn' => '<string>',
        ],
        'StartTimestamp' => <DateTime>,
        'Status' => 'RUNNING|COMPLETED|FAILED',
        'UseMiddleboxes' => true || false,
    ],
]

Result Details

Members
RouteAnalysis
  • Type: RouteAnalysis structure

The route analysis.

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.

UpdateCoreNetwork

$result = $client->updateCoreNetwork([/* ... */]);
$promise = $client->updateCoreNetworkAsync([/* ... */]);

Updates the description of a core network.

Parameter Syntax

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

Parameter Details

Members
CoreNetworkId
  • Required: Yes
  • Type: string

The ID of a core network.

Description
  • Type: string

The description of the update.

Result Syntax

[
    'CoreNetwork' => [
        'CoreNetworkArn' => '<string>',
        'CoreNetworkId' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'Edges' => [
            [
                'Asn' => <integer>,
                'EdgeLocation' => '<string>',
                'InsideCidrBlocks' => ['<string>', ...],
            ],
            // ...
        ],
        'GlobalNetworkId' => '<string>',
        'Segments' => [
            [
                'EdgeLocations' => ['<string>', ...],
                'Name' => '<string>',
                'SharedSegments' => ['<string>', ...],
            ],
            // ...
        ],
        'State' => 'CREATING|UPDATING|AVAILABLE|DELETING',
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Members
CoreNetwork
  • Type: CoreNetwork structure

Returns information about a core network update.

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 Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

Description
  • Type: string

A description of the device.

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.

Constraints: Maximum length of 128 characters.

SerialNumber
  • Type: string

The serial number of the device.

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.

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.

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.

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.

Constraints: Maximum length of 128 characters.

Type
  • Type: string

The type of the link.

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.

UpdateNetworkResourceMetadata

$result = $client->updateNetworkResourceMetadata([/* ... */]);
$promise = $client->updateNetworkResourceMetadataAsync([/* ... */]);

Updates the resource metadata for the specified global network.

Parameter Syntax

$result = $client->updateNetworkResourceMetadata([
    'GlobalNetworkId' => '<string>', // REQUIRED
    'Metadata' => ['<string>', ...], // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
GlobalNetworkId
  • Required: Yes
  • Type: string

The ID of the global network.

Metadata
  • Required: Yes
  • Type: Associative array of custom strings keys (ConstrainedString) to strings

The resource metadata.

ResourceArn
  • Required: Yes
  • Type: string

The ARN of the resource.

Result Syntax

[
    'Metadata' => ['<string>', ...],
    'ResourceArn' => '<string>',
]

Result Details

Members
Metadata
  • Type: Associative array of custom strings keys (ConstrainedString) to strings

The updated resource metadata.

ResourceArn
  • Type: string

The ARN of the resource.

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.

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.

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.

UpdateVpcAttachment

$result = $client->updateVpcAttachment([/* ... */]);
$promise = $client->updateVpcAttachmentAsync([/* ... */]);

Updates a VPC attachment.

Parameter Syntax

$result = $client->updateVpcAttachment([
    'AddSubnetArns' => ['<string>', ...],
    'AttachmentId' => '<string>', // REQUIRED
    'Options' => [
        'ApplianceModeSupport' => true || false,
        'Ipv6Support' => true || false,
    ],
    'RemoveSubnetArns' => ['<string>', ...],
]);

Parameter Details

Members
AddSubnetArns
  • Type: Array of strings

Adds a subnet ARN to the VPC attachment.

AttachmentId
  • Required: Yes
  • Type: string

The ID of the attachment.

Options
  • Type: VpcOptions structure

Additional options for updating the VPC attachment.

RemoveSubnetArns
  • Type: Array of strings

Removes a subnet ARN from the attachment.

Result Syntax

[
    'VpcAttachment' => [
        'Attachment' => [
            'AttachmentId' => '<string>',
            'AttachmentPolicyRuleNumber' => <integer>,
            'AttachmentType' => 'CONNECT|SITE_TO_SITE_VPN|VPC|TRANSIT_GATEWAY_ROUTE_TABLE',
            'CoreNetworkArn' => '<string>',
            'CoreNetworkId' => '<string>',
            'CreatedAt' => <DateTime>,
            'EdgeLocation' => '<string>',
            'OwnerAccountId' => '<string>',
            'ProposedSegmentChange' => [
                'AttachmentPolicyRuleNumber' => <integer>,
                'SegmentName' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'SegmentName' => '<string>',
            'State' => 'REJECTED|PENDING_ATTACHMENT_ACCEPTANCE|CREATING|FAILED|AVAILABLE|UPDATING|PENDING_NETWORK_UPDATE|PENDING_TAG_ACCEPTANCE|DELETING',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'UpdatedAt' => <DateTime>,
        ],
        'Options' => [
            'ApplianceModeSupport' => true || false,
            'Ipv6Support' => true || false,
        ],
        'SubnetArns' => ['<string>', ...],
    ],
]

Result Details

Members
VpcAttachment
  • Type: VpcAttachment structure

Describes the updated VPC attachment.

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 Amazon Web Services.

Members
SubnetArn
  • Type: string

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

Zone
  • Type: string

The Zone that the device is located in. Specify 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

AccountStatus

Description

Describes the current status of an account within an Amazon Web Services Organization, including service-linked roles (SLRs).

Members
AccountId
  • Type: string

The ID of an account within the Amazon Web Services Organization.

SLRDeploymentStatus
  • Type: string

The status of SLR deployment for the account.

Attachment

Description

Describes a core network attachment.

Members
AttachmentId
  • Type: string

The ID of the attachment.

AttachmentPolicyRuleNumber
  • Type: int

The policy rule number associated with the attachment.

AttachmentType
  • Type: string

The type of attachment.

CoreNetworkArn
  • Type: string

The ARN of a core network.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when the attachment was created.

EdgeLocation
  • Type: string

The Region where the edge is located.

OwnerAccountId
  • Type: string

The ID of the attachment account owner.

ProposedSegmentChange
  • Type: ProposedSegmentChange structure

The attachment to move from one segment to another.

ResourceArn
  • Type: string

The attachment resource ARN.

SegmentName
  • Type: string

The name of the segment attachment.

State
  • Type: string

The state of the attachment.

Tags
  • Type: Array of Tag structures

The tags associated with the attachment.

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

The timestamp when the attachment was last updated.

Bandwidth

Description

Describes bandwidth information.

Members
DownloadSpeed
  • Type: int

Download speed in Mbps.

UploadSpeed
  • Type: int

Upload speed in Mbps.

BgpOptions

Description

Describes the BGP options.

Members
PeerAsn
  • Type: long (int|float)

The Peer ASN of the BGP.

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.

ConnectAttachment

Description

Describes a core network Connect attachment.

Members
Attachment
  • Type: Attachment structure

The attachment details.

Options
  • Type: ConnectAttachmentOptions structure

Options for connecting an attachment.

TransportAttachmentId
  • Type: string

The ID of the transport attachment.

ConnectAttachmentOptions

Description

Describes a core network Connect attachment options.

Members
Protocol
  • Type: string

The protocol used for the attachment connection.

ConnectPeer

Description

Describes a core network Connect peer.

Members
Configuration
  • Type: ConnectPeerConfiguration structure

The configuration of the Connect peer.

ConnectAttachmentId
  • Type: string

The ID of the attachment to connect.

ConnectPeerId
  • Type: string

The ID of the Connect peer.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when the Connect peer was created.

EdgeLocation
  • Type: string

The Connect peer Regions where edges are located.

State
  • Type: string

The state of the Connect peer.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the Connect peer.

ConnectPeerAssociation

Description

Describes a core network Connect peer association.

Members
ConnectPeerId
  • Type: string

The ID of the Connect peer.

DeviceId
  • Type: string

The ID of the device to connect to.

GlobalNetworkId
  • Type: string

The ID of the global network.

LinkId
  • Type: string

The ID of the link.

State
  • Type: string

The state of the Connect peer association.

ConnectPeerBgpConfiguration

Description

Describes a core network BGP configuration.

Members
CoreNetworkAddress
  • Type: string

The address of a core network.

CoreNetworkAsn
  • Type: long (int|float)

The ASN of the Coret Network.

PeerAddress
  • Type: string

The address of a core network Connect peer.

PeerAsn
  • Type: long (int|float)

The ASN of the Connect peer.

ConnectPeerConfiguration

Description

Describes a core network Connect peer configuration.

Members
BgpConfigurations
  • Type: Array of ConnectPeerBgpConfiguration structures

The Connect peer BGP configurations.

CoreNetworkAddress
  • Type: string

The IP address of a core network.

InsideCidrBlocks
  • Type: Array of strings

The inside IP addresses used for a Connect peer configuration.

PeerAddress
  • Type: string

The IP address of the Connect peer.

Protocol
  • Type: string

The protocol used for a Connect peer configuration.

ConnectPeerSummary

Description

Summary description of a Connect peer.

Members
ConnectAttachmentId
  • Type: string

The ID of a Connect peer attachment.

ConnectPeerId
  • Type: string

The ID of a Connect peer.

ConnectPeerState
  • Type: string

The state of a Connect peer.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when a Connect peer was created.

EdgeLocation
  • Type: string

The Region where the edge is located.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the Connect peer summary.

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.

ConnectionHealth

Description

Describes connection health.

Members
Status
  • Type: string

The connection status.

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

The time the status was last updated.

Type
  • Type: string

The connection type.

CoreNetwork

Description

Describes a core network.

Members
CoreNetworkArn
  • Type: string

The ARN of a core network.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when a core network was created.

Description
  • Type: string

The description of a core network.

Edges
  • Type: Array of CoreNetworkEdge structures

The edges within a core network.

GlobalNetworkId
  • Type: string

The ID of the global network that your core network is a part of.

Segments
  • Type: Array of CoreNetworkSegment structures

The segments within a core network.

State
  • Type: string

The current state of a core network.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with a core network.

CoreNetworkChange

Description

Details describing a core network change.

Members
Action
  • Type: string

The action to take for a core network.

Identifier
  • Type: string

The resource identifier.

IdentifierPath
  • Type: string

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

NewValues
  • Type: CoreNetworkChangeValues structure

The new value for a core network

PreviousValues
  • Type: CoreNetworkChangeValues structure

The previous values for a core network.

Type
  • Type: string

The type of change.

CoreNetworkChangeEvent

Description

Describes a core network change event. This can be a change to a segment, attachment, route, etc.

Members
Action
  • Type: string

The action taken for the change event.

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

The timestamp for an event change in status.

IdentifierPath
  • Type: string

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

Status
  • Type: string

The status of the core network change event.

Type
  • Type: string

Describes the type of change event.

Values
  • Type: CoreNetworkChangeEventValues structure

Details of the change event.

CoreNetworkChangeEventValues

Description

Describes a core network change event.

Members
AttachmentId
  • Type: string

The ID of the attachment if the change event is associated with an attachment.

Cidr
  • Type: string

For a STATIC_ROUTE event, this is the IP address.

EdgeLocation
  • Type: string

The edge location for the core network change event.

SegmentName
  • Type: string

The segment name if the change event is associated with a segment.

CoreNetworkChangeValues

Description

Describes a core network change.

Members
Asn
  • Type: long (int|float)

The ASN of a core network.

Cidr
  • Type: string

The IP addresses used for a core network.

DestinationIdentifier
  • Type: string

The ID of the destination.

EdgeLocations
  • Type: Array of strings

The Regions where edges are located in a core network.

InsideCidrBlocks
  • Type: Array of strings

The inside IP addresses used for core network change values.

SegmentName
  • Type: string

The names of the segments in a core network.

SharedSegments
  • Type: Array of strings

The shared segments for a core network change value.

CoreNetworkEdge

Description

Describes a core network edge.

Members
Asn
  • Type: long (int|float)

The ASN of a core network edge.

EdgeLocation
  • Type: string

The Region where a core network edge is located.

InsideCidrBlocks
  • Type: Array of strings

The inside IP addresses used for core network edges.

CoreNetworkPolicy

Description

Describes a core network policy. You can have only one LIVE Core Policy.

Members
Alias
  • Type: string

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

ChangeSetState
  • Type: string

The state of a core network policy.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when a core network policy was created.

Description
  • Type: string

The description of a core network policy.

PolicyDocument
  • Type: string (string|number|array|map or anything parsable by json_encode)

Describes a core network policy.

PolicyErrors
  • Type: Array of CoreNetworkPolicyError structures

Describes any errors in a core network policy.

PolicyVersionId
  • Type: int

The ID of the policy version.

CoreNetworkPolicyError

Description

Provides details about an error in a core network policy.

Members
ErrorCode
  • Required: Yes
  • Type: string

The error code associated with a core network policy error.

Message
  • Required: Yes
  • Type: string

The message associated with a core network policy error code.

Path
  • Type: string

The JSON path where the error was discovered in the policy document.

CoreNetworkPolicyException

Description

Describes a core network policy exception.

Members
Errors
  • Type: Array of CoreNetworkPolicyError structures

Describes a core network policy exception.

Message
  • Required: Yes
  • Type: string

CoreNetworkPolicyVersion

Description

Describes a core network policy version.

Members
Alias
  • Type: string

Whether a core network policy is the current policy or the most recently submitted policy.

ChangeSetState
  • Type: string

The status of the policy version change set.

CoreNetworkId
  • Type: string

The ID of a core network.

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

The timestamp when a core network policy version was created.

Description
  • Type: string

The description of a core network policy version.

PolicyVersionId
  • Type: int

The ID of the policy version.

CoreNetworkSegment

Description

Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

Members
EdgeLocations
  • Type: Array of strings

The Regions where the edges are located.

Name
  • Type: string

The name of a core network segment.

SharedSegments
  • Type: Array of strings

The shared segments of a core network.

CoreNetworkSegmentEdgeIdentifier

Description

Returns details about a core network edge.

Members
CoreNetworkId
  • Type: string

The ID of a core network.

EdgeLocation
  • Type: string

The Region where the segment edge is located.

SegmentName
  • Type: string

The name of the segment edge.

CoreNetworkSummary

Description

Returns summary information about a core network.

Members
CoreNetworkArn
  • Type: string

a core network ARN.

CoreNetworkId
  • Type: string

The ID of a core network.

Description
  • Type: string

The description of a core network.

GlobalNetworkId
  • Type: string

The global network ID.

OwnerAccountId
  • Type: string

The ID of the account owner.

State
  • Type: string

The state of a core network.

Tags
  • Type: Array of Tag structures

The key-value tags associated with a core network summary.

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 Amazon Web Services 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. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core 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.

NetworkResource

Description

Describes a network resource.

Members
AccountId
  • Type: string

The Amazon Web Services account ID.

AwsRegion
  • Type: string

The Amazon Web Services Region.

CoreNetworkId
  • Type: string

The ID of a core network.

Definition
  • Type: string

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

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

The time that the resource definition was retrieved.

Metadata
  • Type: Associative array of custom strings keys (ConstrainedString) to strings

The resource metadata.

RegisteredGatewayArn
  • Type: string

The ARN of the gateway.

ResourceArn
  • Type: string

The ARN of the resource.

ResourceId
  • Type: string

The ID of the resource.

ResourceType
  • Type: string

The resource type.

The following are the supported resource types for Direct Connect:

  • dxcon

  • dx-gateway

  • dx-vif

The following are the supported resource types for Network Manager:

  • connection

  • device

  • link

  • site

The following are the supported resource types for Amazon VPC:

  • customer-gateway

  • transit-gateway

  • transit-gateway-attachment

  • transit-gateway-connect-peer

  • transit-gateway-route-table

  • vpn-connection

Tags
  • Type: Array of Tag structures

The tags.

NetworkResourceCount

Description

Describes a resource count.

Members
Count
  • Type: int

The resource count.

ResourceType
  • Type: string

The resource type.

NetworkResourceSummary

Description

Describes a network resource.

Members
Definition
  • Type: string

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

IsMiddlebox
  • Type: boolean

Indicates whether this is a middlebox appliance.

NameTag
  • Type: string

The value for the Name tag.

RegisteredGatewayArn
  • Type: string

The ARN of the gateway.

ResourceArn
  • Type: string

The ARN of the resource.

ResourceType
  • Type: string

The resource type.

NetworkRoute

Description

Describes a network route.

Members
DestinationCidrBlock
  • Type: string

A unique identifier for the route, such as a CIDR block.

Destinations
  • Type: Array of NetworkRouteDestination structures

The destinations.

PrefixListId
  • Type: string

The ID of the prefix list.

State
  • Type: string

The route state. The possible values are active and blackhole.

Type
  • Type: string

The route type. The possible values are propagated and static.

NetworkRouteDestination

Description

Describes the destination of a network route.

Members
CoreNetworkAttachmentId
  • Type: string

The ID of a core network attachment.

EdgeLocation
  • Type: string

The edge location for the network destination.

ResourceId
  • Type: string

The ID of the resource.

ResourceType
  • Type: string

The resource type.

SegmentName
  • Type: string

The name of the segment.

TransitGatewayAttachmentId
  • Type: string

The ID of the transit gateway attachment.

NetworkTelemetry

Description

Describes the telemetry information for a resource.

Members
AccountId
  • Type: string

The Amazon Web Services account ID.

Address
  • Type: string

The address.

AwsRegion
  • Type: string

The Amazon Web Services Region.

CoreNetworkId
  • Type: string

The ID of a core network.

Health
  • Type: ConnectionHealth structure

The connection health.

RegisteredGatewayArn
  • Type: string

The ARN of the gateway.

ResourceArn
  • Type: string

The ARN of the resource.

ResourceId
  • Type: string

The ID of the resource.

ResourceType
  • Type: string

The resource type.

OrganizationStatus

Description

The status of an Amazon Web Services Organization and the accounts within that organization.

Members
AccountStatusList
  • Type: Array of AccountStatus structures

The current service-linked role (SLR) deployment status for an Amazon Web Services Organization's accounts. This will be either SUCCEEDED or IN_PROGRESS.

OrganizationAwsServiceAccessStatus
  • Type: string

The status of the organization's AWS service access. This will be ENABLED or DISABLED.

OrganizationId
  • Type: string

The ID of an Amazon Web Services Organization.

SLRDeploymentStatus
  • Type: string

The status of the SLR deployment for the account. This will be either SUCCEEDED or IN_PROGRESS.

PathComponent

Description

Describes a path component.

Members
DestinationCidrBlock
  • Type: string

The destination CIDR block in the route table.

Resource
  • Type: NetworkResourceSummary structure

The resource.

Sequence
  • Type: int

The sequence number in the path. The destination is 0.

Peering

Description

Describes a peering connection.

Members
CoreNetworkArn
  • Type: string

The ARN of a core network.

CoreNetworkId
  • Type: string

The ID of the core network for the peering request.

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

The timestamp when the attachment peer was created.

EdgeLocation
  • Type: string

The edge location for the peer.

OwnerAccountId
  • Type: string

The ID of the account owner.

PeeringId
  • Type: string

The ID of the peering attachment.

PeeringType
  • Type: string

The type of peering. This will be TRANSIT_GATEWAY.

ResourceArn
  • Type: string

The resource ARN of the peer.

State
  • Type: string

The current state of the peering connection.

Tags
  • Type: Array of Tag structures

The list of key-value tags associated with the peering.

ProposedSegmentChange

Description

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

Members
AttachmentPolicyRuleNumber
  • Type: int

The rule number in the policy document that applies to this change.

SegmentName
  • Type: string

The name of the segment to change.

Tags
  • Type: Array of Tag structures

The list of key-value tags that changed for the segment.

Relationship

Description

Describes a resource relationship.

Members
From
  • Type: string

The ARN of the resource.

To
  • Type: string

The ARN of the resource.

ResourceNotFoundException

Description

The specified resource could not be found.

Members
Context
  • Type: Associative array of custom strings keys (ExceptionContextKey) to strings

The specified resource could not be found.

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

The ID of the resource.

ResourceType
  • Required: Yes
  • Type: string

The resource type.

RouteAnalysis

Description

Describes a route analysis.

Members
Destination
  • Type: RouteAnalysisEndpointOptions structure

The destination.

ForwardPath
  • Type: RouteAnalysisPath structure

The forward path.

GlobalNetworkId
  • Type: string

The ID of the global network.

IncludeReturnPath
  • Type: boolean

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

OwnerAccountId
  • Type: string

The ID of the AWS account that created the route analysis.

ReturnPath
  • Type: RouteAnalysisPath structure

The return path.

RouteAnalysisId
  • Type: string

The ID of the route analysis.

Source
  • Type: RouteAnalysisEndpointOptions structure

The source.

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

The time that the analysis started.

Status
  • Type: string

The status of the route analysis.

UseMiddleboxes
  • Type: boolean

Indicates whether to include the location of middlebox appliances in the route analysis.

RouteAnalysisCompletion

Description

Describes the status of an analysis at completion.

Members
ReasonCode
  • Type: string

The reason code. Available only if a connection is not found.

  • BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.

  • CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.

  • INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.

  • MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.

  • ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.

  • TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.

  • TGW_ATTACH_NOT_FOUND - Cannot find an attachment.

  • TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.

  • TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not associated.

ReasonContext
  • Type: Associative array of custom strings keys (ReasonContextKey) to strings

Additional information about the path. Available only if a connection is not found.

ResultCode
  • Type: string

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

RouteAnalysisEndpointOptions

Description

Describes a source or a destination.

Members
IpAddress
  • Type: string

The IP address.

TransitGatewayArn
  • Type: string

The ARN of the transit gateway.

TransitGatewayAttachmentArn
  • Type: string

The ARN of the transit gateway attachment.

RouteAnalysisEndpointOptionsSpecification

Description

Describes a source or a destination.

Members
IpAddress
  • Type: string

The IP address.

TransitGatewayAttachmentArn
  • Type: string

The ARN of the transit gateway attachment.

RouteAnalysisPath

Description

Describes a route analysis path.

Members
CompletionStatus
  • Type: RouteAnalysisCompletion structure

The status of the analysis at completion.

Path
  • Type: Array of PathComponent structures

The route analysis path.

RouteTableIdentifier

Description

Describes a route table.

Members
CoreNetworkSegmentEdge
  • Type: CoreNetworkSegmentEdgeIdentifier structure

The segment edge in a core network.

TransitGatewayRouteTableArn
  • Type: string

The ARN of the transit gateway route table.

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.

SiteToSiteVpnAttachment

Description

Creates a site-to-site VPN attachment.

Members
Attachment
  • Type: Attachment structure

Provides details about a site-to-site VPN attachment.

VpnConnectionArn
  • Type: string

The ARN of the site-to-site VPN attachment.

Tag

Description

Describes a tag.

Members
Key
  • Type: string

The tag key.

Constraints: Maximum length of 128 characters.

Value
  • Type: string

The tag value.

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.

TransitGatewayPeering

Description

Describes a transit gateway peering attachment.

Members
Peering
  • Type: Peering structure

Describes a transit gateway peer connection.

TransitGatewayArn
  • Type: string

The ARN of the transit gateway.

TransitGatewayPeeringAttachmentId
  • Type: string

The ID of the transit gateway peering attachment.

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.

TransitGatewayRouteTableAttachment

Description

Describes a transit gateway route table attachment.

Members
Attachment
  • Type: Attachment structure

Describes a core network attachment.

PeeringId
  • Type: string

The ID of the peering attachment.

TransitGatewayRouteTableArn
  • Type: string

The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

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.

VpcAttachment

Description

Describes a VPC attachment.

Members
Attachment
  • Type: Attachment structure

Provides details about the VPC attachment.

Options
  • Type: VpcOptions structure

Provides details about the VPC attachment.

SubnetArns
  • Type: Array of strings

The subnet ARNs.

VpcOptions

Description

Describes the VPC options.

Members
ApplianceModeSupport
  • Type: boolean

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

Ipv6Support
  • Type: boolean

Indicates whether IPv6 is supported.

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