Skip to content

CreateTrustedEntitySetRequest

Source code in docs_src/capo_guardduty/types/create_trusted_entity_set_request.py
class CreateTrustedEntitySetRequest(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 a trusted entity set.</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>A user-friendly name to identify the trusted entity set.</p> <p>The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).</p>"""
    format: NotRequired[
        "capo_guardduty.types.trusted_entity_set_format.TrustedEntitySetFormat"
    ]
    """<p>The format of the file that contains the trusted entity set.</p>"""
    location: NotRequired["capo_guardduty.types.location.Location"]
    """<p>The URI of the file that contains the threat entity set. The format of the <code>Location</code> URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-lists-create-activate.html">Format of location URL under Step 2: Adding trusted or threat intelligence data</a> in the <i>Amazon GuardDuty User Guide</i>.</p>"""
    expected_bucket_owner: NotRequired[
        "capo_guardduty.types.expected_bucket_owner.ExpectedBucketOwner"
    ]
    """<p>The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the <b>location</b> parameter.</p>"""
    activate: NotRequired["capo_guardduty.types.boolean.Boolean"]
    """<p>A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.</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 trusted entity set resource.</p>"""

activate instance-attribute

activate: NotRequired[Boolean]

A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.

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 a trusted entity set.

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[ExpectedBucketOwner]

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

format instance-attribute

format: NotRequired[TrustedEntitySetFormat]

The format of the file that contains the trusted entity set.

location instance-attribute

location: NotRequired[Location]

The URI of the file that contains the threat entity set. The format of the Location URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see Format of location URL under Step 2: Adding trusted or threat intelligence data in the Amazon GuardDuty User Guide.

name instance-attribute

name: NotRequired[Name]

A user-friendly name to identify the trusted entity set.

The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

tags instance-attribute

tags: NotRequired[TagMap]

The tags to be added to a new trusted entity set resource.