[ aws . privatenetworks ]
get-network-resource¶
Description¶
Gets the specified network resource.
See also: AWS API Documentation
Synopsis¶
get-network-resource
--network-resource-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--network-resource-arn (string)
The Amazon Resource Name (ARN) of the network 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.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
networkResource -> (structure)
Information about the network resource.
attributes -> (list)
The attributes of the network resource.
(structure)
Information about a name/value pair.
name -> (string)
The name of the pair.
value -> (string)
The value of the pair.
createdAt -> (timestamp)
The creation time of the network resource.
description -> (string)
The description of the network resource.
health -> (string)
The health of the network resource.
model -> (string)
The model of the network resource.
networkArn -> (string)
The Amazon Resource Name (ARN) of the network on which this network resource appears.
networkResourceArn -> (string)
The Amazon Resource Name (ARN) of the network resource.
networkSiteArn -> (string)
The Amazon Resource Name (ARN) of the network site on which this network resource appears.
orderArn -> (string)
The Amazon Resource Name (ARN) of the order used to purchase this network resource.
position -> (structure)
The position of the network resource.
elevation -> (double)
The elevation of the equipment at this position.
elevationReference -> (string)
The reference point from which elevation is reported.
elevationUnit -> (string)
The units used to measure the elevation of the position.
latitude -> (double)
The latitude of the position.
longitude -> (double)
The longitude of the position.
serialNumber -> (string)
The serial number of the network resource.
status -> (string)
The status of the network resource.
statusReason -> (string)
The status reason of the network resource.
type -> (string)
The type of the network resource.
vendor -> (string)
The vendor of the network resource.
tags -> (map)
The network resource tags.
key -> (string)
value -> (string)