Skip to content

Describes one or more global networks

Description

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

Usage

networkmanager_describe_global_networks(GlobalNetworkIds, MaxResults,
  NextToken)

Arguments

  • GlobalNetworkIds

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

  • MaxResults

    The maximum number of results to return.

  • NextToken

    The token for the next page of results.

Value

A list with the following syntax:

list(
  GlobalNetworks = list(
    list(
      GlobalNetworkId = "string",
      GlobalNetworkArn = "string",
      Description = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      State = "PENDING"|"AVAILABLE"|"DELETING"|"UPDATING",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_global_networks(
  GlobalNetworkIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)