Skip to content

CreateIPSetRequest

Source code in docs_src/capo_guardduty/types/create_ip_set_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class CreateIPSetRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    name: NotRequired["capo_guardduty.types.name.Name"]
    """<p>The user-friendly name to identify the IPSet.</p> <p> Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).</p>"""
    format: NotRequired["capo_guardduty.types.ip_set_format.IpSetFormat"]
    """<p>The format of the file that contains the IPSet.</p>"""
    location: NotRequired["capo_guardduty.types.location.Location"]
    """<p>The URI of the file that contains the IPSet. </p>"""
    activate: NotRequired["capo_guardduty.types.boolean.Boolean"]
    """<p>A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.</p>"""
    client_token: NotRequired["capo_guardduty.types.client_token.ClientToken"]
    """<p>The idempotency token for the create request.</p>"""
    tags: NotRequired["capo_guardduty.types.tag_map.TagMap"]
    """<p>The tags to be added to a new IP set resource.</p>"""
    expected_bucket_owner: NotRequired["capo_guardduty.types.account_id.AccountId"]
    """<p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter.</p>"""

activate instance-attribute 

activate: NotRequired[Boolean]

A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

The idempotency token for the create request.

detector_id instance-attribute 

detector_id: DetectorId

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

expected_bucket_owner instance-attribute 

expected_bucket_owner: NotRequired[AccountId]

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

format instance-attribute 

format: NotRequired[IpSetFormat]

The format of the file that contains the IPSet.

location instance-attribute 

location: NotRequired[Location]

The URI of the file that contains the IPSet.

name instance-attribute 

name: NotRequired[Name]

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

tags instance-attribute 

tags: NotRequired[TagMap]

The tags to be added to a new IP set resource.