[ aws . networkmanager ]

get-network-resources

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-network-resources is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: NetworkResources

Synopsis

  get-network-resources
--global-network-id <value>
[--core-network-id <value>]
[--registered-gateway-arn <value>]
[--aws-region <value>]
[--account-id <value>]
[--resource-type <value>]
[--resource-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--global-network-id (string)

The ID of the global network.

--core-network-id (string)

The ID of a core network.

--registered-gateway-arn (string)

The ARN of the gateway.

--aws-region (string)

The Amazon Web Services Region.

--account-id (string)

The Amazon Web Services account ID.

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

--resource-arn (string)

The ARN of the resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

NetworkResources -> (list)

The network resources.

(structure)

Describes a network resource.

RegisteredGatewayArn -> (string)

The ARN of the gateway.

CoreNetworkId -> (string)

a core network ID.

AwsRegion -> (string)

The Amazon Web Services Region.

AccountId -> (string)

The Amazon Web Services account ID.

ResourceType -> (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

ResourceId -> (string)

The ID of the resource.

ResourceArn -> (string)

The ARN of the resource.

Definition -> (string)

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

DefinitionTimestamp -> (timestamp)

The time that the resource definition was retrieved.

Tags -> (list)

The tags.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Constraints: Maximum length of 256 characters.

Metadata -> (map)

The resource metadata.

key -> (string)

value -> (string)

NextToken -> (string)

The token for the next page of results.