get_ip_set¶
Operation¶
get_ip_set
¶
get_ip_set(request: GetIPSetInput | GetIPSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIPSetInputDict]) -> GetIPSetOutput
Retrieves the IPSet specified by the ipSetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIPSetInput | GetIPSetInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetIPSetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIPSetOutput
|
An instance of |
get_ip_set
async
¶
get_ip_set(request: GetIPSetInput | GetIPSetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIPSetInputDict]) -> GetIPSetOutput
Retrieves the IPSet specified by the ipSetId.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIPSetInput | GetIPSetInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetIPSetInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIPSetOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetIPSetInputDict
¶
Bases: TypedDict
Dictionary form of GetIPSetInput.
Attributes¶
detector_id
instance-attribute
¶
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.
GetIPSetInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIPSetInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | 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.
Output¶
GetIPSetOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIPSetOutput structure.
Attributes¶
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | 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.
format
class-attribute
instance-attribute
¶
format: str | None = ...
The format of the file that contains the IPSet.
location
class-attribute
instance-attribute
¶
location: str | None = ...
The URI of the file that contains the IPSet.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The user-friendly name for the IPSet.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.