[ aws . networkmanager ]

get-core-network-policy

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-core-network-policy
--core-network-id <value>
[--policy-version-id <value>]
[--alias <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--core-network-id (string)

The ID of a core network.

--policy-version-id (integer)

The ID of a core network policy version.

--alias (string)

The alias of a core network policy

Possible values:

• LIVE

• LATEST

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

See ‘aws help’ for descriptions of global parameters.

Output

CoreNetworkPolicy -> (structure)

The details about a core network policy.

CoreNetworkId -> (string)

The ID of a core network.

PolicyVersionId -> (integer)

The ID of the policy version.

Alias -> (string)

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

Description -> (string)

The description of a core network policy.

CreatedAt -> (timestamp)

The timestamp when a core network policy was created.

ChangeSetState -> (string)

The state of a core network policy.

PolicyErrors -> (list)

Describes any errors in a core network policy.

(structure)

Provides details about an error in a core network policy.

ErrorCode -> (string)

The error code associated with a core network policy error.

Message -> (string)

The message associated with a core network policy error code.

Path -> (string)

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

PolicyDocument -> (string)

Describes a core network policy.