[ aws . quicksight ]

describe-ip-restriction

Description

Provides a summary and status of IP Rules.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-ip-restriction
--aws-account-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

Your AWS account ID.

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

AwsAccountId -> (string)

Your AWS account ID.

IpRestrictionRuleMap -> (map)

Describes the IP rules with CIDR range and description.

key -> (string)

value -> (string)

Enabled -> (boolean)

Whether or not IP rules are enabled.

RequestId -> (string)

The ID of the describe request.

Status -> (integer)

The status of a set of IP restrictions. A successful request returns a 200 status code.