get_ip_set¶
Operation¶
async
¶
get_ip_set(input: GetIPSetInput, plugins: list[Plugin] | None = None) -> GetIPSetOutput
Retrieves the IPSet specified by the ipSetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetIPSetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetIPSetOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetIPSetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector that is associated with the IPSet.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
class-attribute
instance-attribute
¶
ip_set_id: str | None = None
The unique ID of the IPSet to retrieve.
Output¶
dataclass
¶
Dataclass for GetIPSetOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = None
The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during IPSet creation or update.
class-attribute
instance-attribute
¶
format: IpSetFormat | None = None
The format of the file that contains the IPSet.
class-attribute
instance-attribute
¶
location: str | None = None
The URI of the file that contains the IPSet.
class-attribute
instance-attribute
¶
name: str | None = None
The user-friendly name for the IPSet.
class-attribute
instance-attribute
¶
status: IpSetStatus | None = None
The status of IPSet file that was uploaded.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The tags of the IPSet resource.