[ aws . guardduty ]



Retrieves the IPSet specified by the ipSetId .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--detector-id <value>
--ip-set-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--detector-id (string)

The unique ID of the detector that the IPSet is associated with.

--ip-set-id (string)

The unique ID of the IPSet to retrieve.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To list get details on a specified trusted IP set

The following get-ip-set example shows the status and details of the specififed trusted IP set.

aws guardduty get-ip-set \
    --detector-id 12abc34d567e8fa901bc2d34eexample \
    --ip-set-id d4b94fc952d6912b8f3060768example


    "Status": "ACTIVE",
    "Location": "s3://AWSDOC-EXAMPLE-BUCKET.s3-us-west-2.amazonaws.com/customlist.csv",
    "Tags": {},
    "Format": "TXT",
    "Name": "test-ip-set"

For more information, see Working with Trusted IP Lists and Threat Lists in the GuardDuty User Guide.


Name -> (string)

The user-friendly name for the IPSet.

Format -> (string)

The format of the file that contains the IPSet.

Location -> (string)

The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

Status -> (string)

The status of IPSet file that was uploaded.

Tags -> (map)

The tags of the IPSet resource.

key -> (string)

value -> (string)